FHIR Implementation Guide for ABDM
6.5.0 - active
This page is part of the FHIR Implementation Guide for ABDM (v6.5.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/Media | Version: 6.5.0 | |||
Draft as of 2020-08-17 | Computable Name: Media |
This profile sets minimum expectations for the Media resource to searching for and fetching media like a photo, video, or audio recording acquired or used in healthcare, associated with a patient or provider.
This profile sets minimum expectations for the Media resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter associated with media ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Actual Media - reference or data ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | |
Media.content.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Media | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Media
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
Media | |||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | |
![]() ![]() ![]() |
S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of acquisition equipment/process |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of | |
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter associated with media | |
![]() ![]() ![]() |
0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image | |
![]() ![]() ![]() |
S | 1..1 | Attachment | Actual Media - reference or data |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of referenced event | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
![]() ![]() ![]() |
Σ | 0..1 | When Media was collected | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the device/manufacturer | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
![]() ![]() ![]() |
Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Actual Media - reference or data | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about the media | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Media.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | example | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Media.content.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
Media.content.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
|
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Media | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Media
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter associated with media ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Actual Media - reference or data ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | |
Media.content.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Media | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Media
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
Media | |||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | |
![]() ![]() ![]() |
S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of acquisition equipment/process |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of | |
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter associated with media | |
![]() ![]() ![]() |
0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image | |
![]() ![]() ![]() |
S | 1..1 | Attachment | Actual Media - reference or data |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of referenced event | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
![]() ![]() ![]() |
Σ | 0..1 | When Media was collected | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the device/manufacturer | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
![]() ![]() ![]() |
Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Actual Media - reference or data | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about the media | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Media.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | example | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Media.content.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
Media.content.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
|
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Media | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Media
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron