medias

Create Media

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

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringMediaThis is a Media resource
identifierarray(Identifier)Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.
basedOnarray(Reference)A procedure that is fulfilled in whole or in part by the creation of this media.
typestringphoto|video|audioWhether the media is a photo (still image), an audio recording, or a video recording.
subtypeCodeableConceptDetails of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.
viewCodeableConceptThe name of the imaging view e.g. Lateral or Antero-posterior (AP).
subjectReferenceWho/What this Media is a record of.
contextReferenceThe encounter or episode of care that establishes the context for this media.
occurrenceDateTimestringThe date and time(s) at which the media was collected.
occurrencePeriodPeriodThe date and time(s) at which the media was collected.
operatorReferenceThe person who administered the collection of the image.
reasonCodearray(CodeableConcept)Describes why the event occurred in coded or textual form.
bodySiteCodeableConceptIndicates the site on the subject's body where the media was collected (i.e. the target site).
deviceReferenceThe device used to collect the media.
heightnumberHeight of the image in pixels (photo/video).
widthnumberWidth of the image in pixels (photo/video).
framesnumberThe number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
durationnumberThe duration of the recording in seconds - for audio and video.
content*AttachmentThe actual content of the media - inline or by direct reference to the media source file.
notearray(Annotation)Comments made about the media by the performer, subject or other participants.

Response

Patch Media

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

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

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*stringMediaThis is a Media resource
identifierarray(Identifier)Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.
basedOnarray(Reference)A procedure that is fulfilled in whole or in part by the creation of this media.
typestringphoto|video|audioWhether the media is a photo (still image), an audio recording, or a video recording.
subtypeCodeableConceptDetails of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.
viewCodeableConceptThe name of the imaging view e.g. Lateral or Antero-posterior (AP).
subjectReferenceWho/What this Media is a record of.
contextReferenceThe encounter or episode of care that establishes the context for this media.
occurrenceDateTimestringThe date and time(s) at which the media was collected.
occurrencePeriodPeriodThe date and time(s) at which the media was collected.
operatorReferenceThe person who administered the collection of the image.
reasonCodearray(CodeableConcept)Describes why the event occurred in coded or textual form.
bodySiteCodeableConceptIndicates the site on the subject's body where the media was collected (i.e. the target site).
deviceReferenceThe device used to collect the media.
heightnumberHeight of the image in pixels (photo/video).
widthnumberWidth of the image in pixels (photo/video).
framesnumberThe number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
durationnumberThe duration of the recording in seconds - for audio and video.
content*AttachmentThe actual content of the media - inline or by direct reference to the media source file.
notearray(Annotation)Comments made about the media by the performer, subject or other participants.

Response

Read Media

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
based-onstring
contextstring
createdstring
datestring
devicestring
identifierstring
operatorstring
patientstring
sitestring
subjectstring
subtypestring
typestring
viewstring

Params

organizationId*string|stringid|slug

Response

Search History Media

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

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

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

Request

Headers

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

Query params

_idstring
_languagestring
based-onstring
contextstring
createdstring
datestring
devicestring
identifierstring
operatorstring
patientstring
sitestring
subjectstring
subtypestring
typestring
viewstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringMediaThis is a Media resource
identifierarray(Identifier)Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.
basedOnarray(Reference)A procedure that is fulfilled in whole or in part by the creation of this media.
typestringphoto|video|audioWhether the media is a photo (still image), an audio recording, or a video recording.
subtypeCodeableConceptDetails of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.
viewCodeableConceptThe name of the imaging view e.g. Lateral or Antero-posterior (AP).
subjectReferenceWho/What this Media is a record of.
contextReferenceThe encounter or episode of care that establishes the context for this media.
occurrenceDateTimestringThe date and time(s) at which the media was collected.
occurrencePeriodPeriodThe date and time(s) at which the media was collected.
operatorReferenceThe person who administered the collection of the image.
reasonCodearray(CodeableConcept)Describes why the event occurred in coded or textual form.
bodySiteCodeableConceptIndicates the site on the subject's body where the media was collected (i.e. the target site).
deviceReferenceThe device used to collect the media.
heightnumberHeight of the image in pixels (photo/video).
widthnumberWidth of the image in pixels (photo/video).
framesnumberThe number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
durationnumberThe duration of the recording in seconds - for audio and video.
content*AttachmentThe actual content of the media - inline or by direct reference to the media source file.
notearray(Annotation)Comments made about the media by the performer, subject or other participants.

Response

Update Media

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

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMediaThis is a Media resource
identifierarray(Identifier)Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.
basedOnarray(Reference)A procedure that is fulfilled in whole or in part by the creation of this media.
typestringphoto|video|audioWhether the media is a photo (still image), an audio recording, or a video recording.
subtypeCodeableConceptDetails of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.
viewCodeableConceptThe name of the imaging view e.g. Lateral or Antero-posterior (AP).
subjectReferenceWho/What this Media is a record of.
contextReferenceThe encounter or episode of care that establishes the context for this media.
occurrenceDateTimestringThe date and time(s) at which the media was collected.
occurrencePeriodPeriodThe date and time(s) at which the media was collected.
operatorReferenceThe person who administered the collection of the image.
reasonCodearray(CodeableConcept)Describes why the event occurred in coded or textual form.
bodySiteCodeableConceptIndicates the site on the subject's body where the media was collected (i.e. the target site).
deviceReferenceThe device used to collect the media.
heightnumberHeight of the image in pixels (photo/video).
widthnumberWidth of the image in pixels (photo/video).
framesnumberThe number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
durationnumberThe duration of the recording in seconds - for audio and video.
content*AttachmentThe actual content of the media - inline or by direct reference to the media source file.
notearray(Annotation)Comments made about the media by the performer, subject or other participants.

Response