imaging studys

Create Imaging Study

post
/organizations/{organizationId}/fhir/3/ImagingStudy

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringImagingStudyThis is a ImagingStudy resource
uidstringFormal identifier for the study.
accessionIdentifierAccession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).
identifierarray(Identifier)Other identifiers for the study.
availabilitystringONLINE|OFFLINE|NEARLINE|UNAVAILABLEAvailability of study (online, offline, or nearline).
modalityListarray(Coding)A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
patient*ReferenceThe patient imaged in the study.
contextReferenceThe encounter or episode at which the request is initiated.
startedstringDate and time the study started.
basedOnarray(Reference)A list of the diagnostic requests that resulted in this imaging study being performed.
referrerReferenceThe requesting/referring physician.
interpreterarray(Reference)Who read the study and interpreted the images or other content.
endpointarray(Reference)The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.
numberOfSeriesnumberNumber of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
numberOfInstancesnumberNumber of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
procedureReferencearray(Reference)A reference to the performed Procedure.
procedureCodearray(CodeableConcept)The code for the performed procedure type.
reasonCodeableConceptDescription of clinical condition indicating why the ImagingStudy was requested.
descriptionstringInstitution-generated description or classification of the Study performed.
seriesarray(ImagingStudy_Series)Each study has one or more series of images or other content.

Response

Patch Imaging Study

patch
/organizations/{organizationId}/fhir/3/ImagingStudy/{resourceId}

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImagingStudyThis is a ImagingStudy resource
uidstringFormal identifier for the study.
accessionIdentifierAccession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).
identifierarray(Identifier)Other identifiers for the study.
availabilitystringONLINE|OFFLINE|NEARLINE|UNAVAILABLEAvailability of study (online, offline, or nearline).
modalityListarray(Coding)A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
patient*ReferenceThe patient imaged in the study.
contextReferenceThe encounter or episode at which the request is initiated.
startedstringDate and time the study started.
basedOnarray(Reference)A list of the diagnostic requests that resulted in this imaging study being performed.
referrerReferenceThe requesting/referring physician.
interpreterarray(Reference)Who read the study and interpreted the images or other content.
endpointarray(Reference)The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.
numberOfSeriesnumberNumber of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
numberOfInstancesnumberNumber of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
procedureReferencearray(Reference)A reference to the performed Procedure.
procedureCodearray(CodeableConcept)The code for the performed procedure type.
reasonCodeableConceptDescription of clinical condition indicating why the ImagingStudy was requested.
descriptionstringInstitution-generated description or classification of the Study performed.
seriesarray(ImagingStudy_Series)Each study has one or more series of images or other content.

Response

Read Imaging Study

get
/organizations/{organizationId}/fhir/3/ImagingStudy/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Imaging Study

get
/organizations/{organizationId}/fhir/3/ImagingStudy/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Imaging Study

get
/organizations/{organizationId}/fhir/3/ImagingStudy/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Imaging Study

delete
/organizations/{organizationId}/fhir/3/ImagingStudy/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Imaging Study

get
/organizations/{organizationId}/fhir/3/ImagingStudy

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
accessionstring
basedonstring
bodysitestring
contextstring
dicom-classstring
endpointstring
identifierstring
modalitystring
patientstring
performerstring
reasonstring
seriesstring
startedstring
studystring
uidstring

Params

organizationId*string|stringid|slug

Response

Search History Imaging Study

get
/organizations/{organizationId}/fhir/3/ImagingStudy/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Imaging Study

post
/organizations/{organizationId}/fhir/3/ImagingStudy/_search

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
accessionstring
basedonstring
bodysitestring
contextstring
dicom-classstring
endpointstring
identifierstring
modalitystring
patientstring
performerstring
reasonstring
seriesstring
startedstring
studystring
uidstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringImagingStudyThis is a ImagingStudy resource
uidstringFormal identifier for the study.
accessionIdentifierAccession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).
identifierarray(Identifier)Other identifiers for the study.
availabilitystringONLINE|OFFLINE|NEARLINE|UNAVAILABLEAvailability of study (online, offline, or nearline).
modalityListarray(Coding)A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
patient*ReferenceThe patient imaged in the study.
contextReferenceThe encounter or episode at which the request is initiated.
startedstringDate and time the study started.
basedOnarray(Reference)A list of the diagnostic requests that resulted in this imaging study being performed.
referrerReferenceThe requesting/referring physician.
interpreterarray(Reference)Who read the study and interpreted the images or other content.
endpointarray(Reference)The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.
numberOfSeriesnumberNumber of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
numberOfInstancesnumberNumber of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
procedureReferencearray(Reference)A reference to the performed Procedure.
procedureCodearray(CodeableConcept)The code for the performed procedure type.
reasonCodeableConceptDescription of clinical condition indicating why the ImagingStudy was requested.
descriptionstringInstitution-generated description or classification of the Study performed.
seriesarray(ImagingStudy_Series)Each study has one or more series of images or other content.

Response

Update Imaging Study

put
/organizations/{organizationId}/fhir/3/ImagingStudy/{resourceId}

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImagingStudyThis is a ImagingStudy resource
uidstringFormal identifier for the study.
accessionIdentifierAccession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).
identifierarray(Identifier)Other identifiers for the study.
availabilitystringONLINE|OFFLINE|NEARLINE|UNAVAILABLEAvailability of study (online, offline, or nearline).
modalityListarray(Coding)A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
patient*ReferenceThe patient imaged in the study.
contextReferenceThe encounter or episode at which the request is initiated.
startedstringDate and time the study started.
basedOnarray(Reference)A list of the diagnostic requests that resulted in this imaging study being performed.
referrerReferenceThe requesting/referring physician.
interpreterarray(Reference)Who read the study and interpreted the images or other content.
endpointarray(Reference)The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.
numberOfSeriesnumberNumber of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
numberOfInstancesnumberNumber of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
procedureReferencearray(Reference)A reference to the performed Procedure.
procedureCodearray(CodeableConcept)The code for the performed procedure type.
reasonCodeableConceptDescription of clinical condition indicating why the ImagingStudy was requested.
descriptionstringInstitution-generated description or classification of the Study performed.
seriesarray(ImagingStudy_Series)Each study has one or more series of images or other content.

Response