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*	string	application/json\|application/json+fhir	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	Media	This is a Media resource
identifier	array(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.
basedOn	array(Reference)		A procedure that is fulfilled in whole or in part by the creation of this media.
type	string	photo\|video\|audio	Whether the media is a photo (still image), an audio recording, or a video recording.
subtype	CodeableConcept		Details 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.
view	CodeableConcept		The name of the imaging view e.g. Lateral or Antero-posterior (AP).
subject	Reference		Who/What this Media is a record of.
context	Reference		The encounter or episode of care that establishes the context for this media.
occurrenceDateTime	string		The date and time(s) at which the media was collected.
occurrencePeriod	Period		The date and time(s) at which the media was collected.
operator	Reference		The person who administered the collection of the image.
reasonCode	array(CodeableConcept)		Describes why the event occurred in coded or textual form.
bodySite	CodeableConcept		Indicates the site on the subject's body where the media was collected (i.e. the target site).
device	Reference		The device used to collect the media.
height	number		Height of the image in pixels (photo/video).
width	number		Width of the image in pixels (photo/video).
frames	number		The 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.
duration	number		The duration of the recording in seconds - for audio and video.
content*	Attachment		The actual content of the media - inline or by direct reference to the media source file.
note	array(Annotation)		Comments made about the media by the performer, subject or other participants.

Response

201 400 401 404

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*	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	Media	This is a Media resource
identifier	array(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.
basedOn	array(Reference)		A procedure that is fulfilled in whole or in part by the creation of this media.
type	string	photo\|video\|audio	Whether the media is a photo (still image), an audio recording, or a video recording.
subtype	CodeableConcept		Details 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.
view	CodeableConcept		The name of the imaging view e.g. Lateral or Antero-posterior (AP).
subject	Reference		Who/What this Media is a record of.
context	Reference		The encounter or episode of care that establishes the context for this media.
occurrenceDateTime	string		The date and time(s) at which the media was collected.
occurrencePeriod	Period		The date and time(s) at which the media was collected.
operator	Reference		The person who administered the collection of the image.
reasonCode	array(CodeableConcept)		Describes why the event occurred in coded or textual form.
bodySite	CodeableConcept		Indicates the site on the subject's body where the media was collected (i.e. the target site).
device	Reference		The device used to collect the media.
height	number		Height of the image in pixels (photo/video).
width	number		Width of the image in pixels (photo/video).
frames	number		The 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.
duration	number		The duration of the recording in seconds - for audio and video.
content*	Attachment		The actual content of the media - inline or by direct reference to the media source file.
note	array(Annotation)		Comments made about the media by the performer, subject or other participants.

Response

200 201 400 401 404 409

Read Media

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Media

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Media

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Media

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Media

get

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

Request

Headers


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

Query params


_id	string
_language	string
based-on	string
context	string
created	string
date	string
device	string
identifier	string
operator	string
patient	string
site	string
subject	string
subtype	string
type	string
view	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Media

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 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*	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
based-on	string
context	string
created	string
date	string
device	string
identifier	string
operator	string
patient	string
site	string
subject	string
subtype	string
type	string
view	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Media	This is a Media resource
identifier	array(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.
basedOn	array(Reference)		A procedure that is fulfilled in whole or in part by the creation of this media.
type	string	photo\|video\|audio	Whether the media is a photo (still image), an audio recording, or a video recording.
subtype	CodeableConcept		Details 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.
view	CodeableConcept		The name of the imaging view e.g. Lateral or Antero-posterior (AP).
subject	Reference		Who/What this Media is a record of.
context	Reference		The encounter or episode of care that establishes the context for this media.
occurrenceDateTime	string		The date and time(s) at which the media was collected.
occurrencePeriod	Period		The date and time(s) at which the media was collected.
operator	Reference		The person who administered the collection of the image.
reasonCode	array(CodeableConcept)		Describes why the event occurred in coded or textual form.
bodySite	CodeableConcept		Indicates the site on the subject's body where the media was collected (i.e. the target site).
device	Reference		The device used to collect the media.
height	number		Height of the image in pixels (photo/video).
width	number		Width of the image in pixels (photo/video).
frames	number		The 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.
duration	number		The duration of the recording in seconds - for audio and video.
content*	Attachment		The actual content of the media - inline or by direct reference to the media source file.
note	array(Annotation)		Comments made about the media by the performer, subject or other participants.

Response

200 401 404

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*	string	application/json\|application/json+fhir	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	Media	This is a Media resource
identifier	array(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.
basedOn	array(Reference)		A procedure that is fulfilled in whole or in part by the creation of this media.
type	string	photo\|video\|audio	Whether the media is a photo (still image), an audio recording, or a video recording.
subtype	CodeableConcept		Details 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.
view	CodeableConcept		The name of the imaging view e.g. Lateral or Antero-posterior (AP).
subject	Reference		Who/What this Media is a record of.
context	Reference		The encounter or episode of care that establishes the context for this media.
occurrenceDateTime	string		The date and time(s) at which the media was collected.
occurrencePeriod	Period		The date and time(s) at which the media was collected.
operator	Reference		The person who administered the collection of the image.
reasonCode	array(CodeableConcept)		Describes why the event occurred in coded or textual form.
bodySite	CodeableConcept		Indicates the site on the subject's body where the media was collected (i.e. the target site).
device	Reference		The device used to collect the media.
height	number		Height of the image in pixels (photo/video).
width	number		Width of the image in pixels (photo/video).
frames	number		The 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.
duration	number		The duration of the recording in seconds - for audio and video.
content*	Attachment		The actual content of the media - inline or by direct reference to the media source file.
note	array(Annotation)		Comments made about the media by the performer, subject or other participants.

Response

200 201 400 401 404 409