imaging manifests

Create Imaging Manifest

post

/organizations/{organizationId}/fhir/3/ImagingManifest

A text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.

Request

Headers


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

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ImagingManifest	This is a ImagingManifest resource
identifier	Identifier		Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
patient*	Reference		A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
authoringTime	string		Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
author	Reference		Author of ImagingManifest. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.
description	string		Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.
study*	array(ImagingManifest_Study)		Study identity and locating information of the DICOM SOP instances in the selection.

Response

201 400 401 404

Patch Imaging Manifest

patch

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

A text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.

Request

Headers


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

Params


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

Body


resourceType*	string	ImagingManifest	This is a ImagingManifest resource
identifier	Identifier		Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
patient*	Reference		A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
authoringTime	string		Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
author	Reference		Author of ImagingManifest. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.
description	string		Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.
study*	array(ImagingManifest_Study)		Study identity and locating information of the DICOM SOP instances in the selection.

Response

200 201 400 401 404 409

Read Imaging Manifest

get

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

Request

Headers


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

Params


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

Response

200 401 404

Read History Imaging Manifest

get

/organizations/{organizationId}/fhir/3/ImagingManifest/{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 401 404

Read Version Imaging Manifest

get

/organizations/{organizationId}/fhir/3/ImagingManifest/{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>

Params


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

Response

200 400 401 404

Remove Imaging Manifest

delete

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

Request

Headers


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

Params


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

Response

200 204 400 401 404 409

Search Get Imaging Manifest

get

/organizations/{organizationId}/fhir/3/ImagingManifest

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
author	string
authoring-time	string
endpoint	string
identifier	string
imaging-study	string
patient	string
selected-study	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Imaging Manifest

get

/organizations/{organizationId}/fhir/3/ImagingManifest/_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 401 404

Search Post Imaging Manifest

post

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

A text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.

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
author	string
authoring-time	string
endpoint	string
identifier	string
imaging-study	string
patient	string
selected-study	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ImagingManifest	This is a ImagingManifest resource
identifier	Identifier		Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
patient*	Reference		A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
authoringTime	string		Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
author	Reference		Author of ImagingManifest. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.
description	string		Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.
study*	array(ImagingManifest_Study)		Study identity and locating information of the DICOM SOP instances in the selection.

Response

200 401 404

Update Imaging Manifest

put

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

A text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.

Request

Headers


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

Params


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

Body


resourceType*	string	ImagingManifest	This is a ImagingManifest resource
identifier	Identifier		Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
patient*	Reference		A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
authoringTime	string		Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
author	Reference		Author of ImagingManifest. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.
description	string		Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.
study*	array(ImagingManifest_Study)		Study identity and locating information of the DICOM SOP instances in the selection.

Response

200 201 400 401 404 409