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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringImagingManifestThis is a ImagingManifest resource
identifierIdentifierUnique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
patient*ReferenceA patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
authoringTimestringDate 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).
authorReferenceAuthor 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.
descriptionstringFree 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

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImagingManifestThis is a ImagingManifest resource
identifierIdentifierUnique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
patient*ReferenceA patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
authoringTimestringDate 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).
authorReferenceAuthor 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.
descriptionstringFree 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

Read Imaging Manifest

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
authorstring
authoring-timestring
endpointstring
identifierstring
imaging-studystring
patientstring
selected-studystring

Params

organizationId*string|stringid|slug

Response

Search History Imaging Manifest

get
/organizations/{organizationId}/fhir/3/ImagingManifest/_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 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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
authoring-timestring
endpointstring
identifierstring
imaging-studystring
patientstring
selected-studystring

Params

organizationId*string|stringid|slug

Body

resourceType*stringImagingManifestThis is a ImagingManifest resource
identifierIdentifierUnique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
patient*ReferenceA patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
authoringTimestringDate 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).
authorReferenceAuthor 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.
descriptionstringFree 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

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImagingManifestThis is a ImagingManifest resource
identifierIdentifierUnique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
patient*ReferenceA patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
authoringTimestringDate 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).
authorReferenceAuthor 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.
descriptionstringFree 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