medias
Create Media
post
/organizations/{organizationId}/fhir/4/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* | This is a Media resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
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. | |
partOf | array(Reference) | A larger event of which this particular event is a component or step. | |
status | code | The current state of the {{title}}. | |
type | CodeableConcept | A code that classifies whether the media is an image, video or audio recording or some other media category. | |
modality | 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. | |
encounter | Reference | The encounter that establishes the context for this media. | |
createdDateTime | string | The date and time(s) at which the media was collected. | |
createdPeriod | Period | The date and time(s) at which the media was collected. | |
issued | instant | The date and time this version of the media was made available to providers, typically after having been reviewed. | |
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 observation was made (i.e. the target site). | |
deviceName | string | The name of the device / manufacturer of the device that was used to make the recording. | |
device | Reference | The device used to collect the media. | |
height | positiveInt | Height of the image in pixels (photo/video). | |
width | positiveInt | Width of the image in pixels (photo/video). | |
frames | positiveInt | 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 | decimal | 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
keyboard_arrow_down
Patch Media
patch
/organizations/{organizationId}/fhir/4/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* | This is a Media resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
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. | |
partOf | array(Reference) | A larger event of which this particular event is a component or step. | |
status | code | The current state of the {{title}}. | |
type | CodeableConcept | A code that classifies whether the media is an image, video or audio recording or some other media category. | |
modality | 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. | |
encounter | Reference | The encounter that establishes the context for this media. | |
createdDateTime | string | The date and time(s) at which the media was collected. | |
createdPeriod | Period | The date and time(s) at which the media was collected. | |
issued | instant | The date and time this version of the media was made available to providers, typically after having been reviewed. | |
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 observation was made (i.e. the target site). | |
deviceName | string | The name of the device / manufacturer of the device that was used to make the recording. | |
device | Reference | The device used to collect the media. | |
height | positiveInt | Height of the image in pixels (photo/video). | |
width | positiveInt | Width of the image in pixels (photo/video). | |
frames | positiveInt | 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 | decimal | 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
keyboard_arrow_down
Read Media
get
/organizations/{organizationId}/fhir/4/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
keyboard_arrow_down
Read History Media
get
/organizations/{organizationId}/fhir/4/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
keyboard_arrow_down
Read Version Media
get
/organizations/{organizationId}/fhir/4/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
keyboard_arrow_down
Remove Media
delete
/organizations/{organizationId}/fhir/4/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
keyboard_arrow_down
Search Get Media
get
/organizations/{organizationId}/fhir/4/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 | ||
created | string | ||
device | string | ||
emcpunter | string | ||
identifier | string | ||
modality | string | ||
operator | string | ||
patient | string | ||
site | string | ||
status | string | ||
subject | string | ||
type | string | ||
view | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Media
get
/organizations/{organizationId}/fhir/4/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
keyboard_arrow_down
Search Post Media
post
/organizations/{organizationId}/fhir/4/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 | ||
created | string | ||
device | string | ||
emcpunter | string | ||
identifier | string | ||
modality | string | ||
operator | string | ||
patient | string | ||
site | string | ||
status | string | ||
subject | string | ||
type | string | ||
view | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Media resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
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. | |
partOf | array(Reference) | A larger event of which this particular event is a component or step. | |
status | code | The current state of the {{title}}. | |
type | CodeableConcept | A code that classifies whether the media is an image, video or audio recording or some other media category. | |
modality | 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. | |
encounter | Reference | The encounter that establishes the context for this media. | |
createdDateTime | string | The date and time(s) at which the media was collected. | |
createdPeriod | Period | The date and time(s) at which the media was collected. | |
issued | instant | The date and time this version of the media was made available to providers, typically after having been reviewed. | |
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 observation was made (i.e. the target site). | |
deviceName | string | The name of the device / manufacturer of the device that was used to make the recording. | |
device | Reference | The device used to collect the media. | |
height | positiveInt | Height of the image in pixels (photo/video). | |
width | positiveInt | Width of the image in pixels (photo/video). | |
frames | positiveInt | 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 | decimal | 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
keyboard_arrow_down
Update Media
put
/organizations/{organizationId}/fhir/4/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* | This is a Media resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
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. | |
partOf | array(Reference) | A larger event of which this particular event is a component or step. | |
status | code | The current state of the {{title}}. | |
type | CodeableConcept | A code that classifies whether the media is an image, video or audio recording or some other media category. | |
modality | 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. | |
encounter | Reference | The encounter that establishes the context for this media. | |
createdDateTime | string | The date and time(s) at which the media was collected. | |
createdPeriod | Period | The date and time(s) at which the media was collected. | |
issued | instant | The date and time this version of the media was made available to providers, typically after having been reviewed. | |
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 observation was made (i.e. the target site). | |
deviceName | string | The name of the device / manufacturer of the device that was used to make the recording. | |
device | Reference | The device used to collect the media. | |
height | positiveInt | Height of the image in pixels (photo/video). | |
width | positiveInt | Width of the image in pixels (photo/video). | |
frames | positiveInt | 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 | decimal | 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
keyboard_arrow_down