imaging studys

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*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ImagingStudy	This is a ImagingStudy resource
uid	string		Formal identifier for the study.
accession	Identifier		Accession 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).
identifier	array(Identifier)		Other identifiers for the study.
availability	string	ONLINE\|OFFLINE\|NEARLINE\|UNAVAILABLE	Availability of study (online, offline, or nearline).
modalityList	array(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*	Reference		The patient imaged in the study.
context	Reference		The encounter or episode at which the request is initiated.
started	string		Date and time the study started.
basedOn	array(Reference)		A list of the diagnostic requests that resulted in this imaging study being performed.
referrer	Reference		The requesting/referring physician.
interpreter	array(Reference)		Who read the study and interpreted the images or other content.
endpoint	array(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.
numberOfSeries	number		Number 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.
numberOfInstances	number		Number 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.
procedureReference	array(Reference)		A reference to the performed Procedure.
procedureCode	array(CodeableConcept)		The code for the performed procedure type.
reason	CodeableConcept		Description of clinical condition indicating why the ImagingStudy was requested.
description	string		Institution-generated description or classification of the Study performed.
series	array(ImagingStudy_Series)		Each study has one or more series of images or other content.

Response

200 400 401 404

patch

/organizations/{organizationId}/fhir/3/imagingstudy/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	ImagingStudy	This is a ImagingStudy resource
uid	string		Formal identifier for the study.
accession	Identifier		Accession 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).
identifier	array(Identifier)		Other identifiers for the study.
availability	string	ONLINE\|OFFLINE\|NEARLINE\|UNAVAILABLE	Availability of study (online, offline, or nearline).
modalityList	array(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*	Reference		The patient imaged in the study.
context	Reference		The encounter or episode at which the request is initiated.
started	string		Date and time the study started.
basedOn	array(Reference)		A list of the diagnostic requests that resulted in this imaging study being performed.
referrer	Reference		The requesting/referring physician.
interpreter	array(Reference)		Who read the study and interpreted the images or other content.
endpoint	array(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.
numberOfSeries	number		Number 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.
numberOfInstances	number		Number 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.
procedureReference	array(Reference)		A reference to the performed Procedure.
procedureCode	array(CodeableConcept)		The code for the performed procedure type.
reason	CodeableConcept		Description of clinical condition indicating why the ImagingStudy was requested.
description	string		Institution-generated description or classification of the Study performed.
series	array(ImagingStudy_Series)		Each study has one or more series of images or other content.

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/imagingstudy/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/imagingstudy/{resourceId}/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/imagingstudy/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

delete

/organizations/{organizationId}/fhir/3/imagingstudy/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/imagingstudy

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
accession	string
basedon	string
bodysite	string
context	string
dicom-class	string
endpoint	string
identifier	string
modality	string
patient	string
performer	string
reason	string
series	string
started	string
study	string
uid	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/imagingstudy/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

post

/organizations/{organizationId}/fhir/3/imagingstudy/_search

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
accession	string
basedon	string
bodysite	string
context	string
dicom-class	string
endpoint	string
identifier	string
modality	string
patient	string
performer	string
reason	string
series	string
started	string
study	string
uid	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ImagingStudy	This is a ImagingStudy resource
uid	string		Formal identifier for the study.
accession	Identifier		Accession 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).
identifier	array(Identifier)		Other identifiers for the study.
availability	string	ONLINE\|OFFLINE\|NEARLINE\|UNAVAILABLE	Availability of study (online, offline, or nearline).
modalityList	array(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*	Reference		The patient imaged in the study.
context	Reference		The encounter or episode at which the request is initiated.
started	string		Date and time the study started.
basedOn	array(Reference)		A list of the diagnostic requests that resulted in this imaging study being performed.
referrer	Reference		The requesting/referring physician.
interpreter	array(Reference)		Who read the study and interpreted the images or other content.
endpoint	array(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.
numberOfSeries	number		Number 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.
numberOfInstances	number		Number 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.
procedureReference	array(Reference)		A reference to the performed Procedure.
procedureCode	array(CodeableConcept)		The code for the performed procedure type.
reason	CodeableConcept		Description of clinical condition indicating why the ImagingStudy was requested.
description	string		Institution-generated description or classification of the Study performed.
series	array(ImagingStudy_Series)		Each study has one or more series of images or other content.

Response

200 400 401 404

put

/organizations/{organizationId}/fhir/3/imagingstudy/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	ImagingStudy	This is a ImagingStudy resource
uid	string		Formal identifier for the study.
accession	Identifier		Accession 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).
identifier	array(Identifier)		Other identifiers for the study.
availability	string	ONLINE\|OFFLINE\|NEARLINE\|UNAVAILABLE	Availability of study (online, offline, or nearline).
modalityList	array(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*	Reference		The patient imaged in the study.
context	Reference		The encounter or episode at which the request is initiated.
started	string		Date and time the study started.
basedOn	array(Reference)		A list of the diagnostic requests that resulted in this imaging study being performed.
referrer	Reference		The requesting/referring physician.
interpreter	array(Reference)		Who read the study and interpreted the images or other content.
endpoint	array(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.
numberOfSeries	number		Number 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.
numberOfInstances	number		Number 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.
procedureReference	array(Reference)		A reference to the performed Procedure.
procedureCode	array(CodeableConcept)		The code for the performed procedure type.
reason	CodeableConcept		Description of clinical condition indicating why the ImagingStudy was requested.
description	string		Institution-generated description or classification of the Study performed.
series	array(ImagingStudy_Series)		Each study has one or more series of images or other content.

Response

200 400 401 404