FHIR Implementation Guide for ABDM
3.0.0 - CI Build
FHIR Implementation Guide for ABDM
3.0.0 - CI Build
FHIR Implementation Guide for ABDM - Local Development build (v3.0.0). See the Directory of published versions
| Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/Media | Version: 3.0.0 | |||
| Draft as of 2020-08-17 | Computable Name: Media | |||
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.
This structure is derived from Media
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
  basedOn | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | |
 status | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
 modality | S | 0..1 | CodeableConcept | The type of acquisition equipment/process |
 coding | S | 0..* | Coding | Code defined by a terminology system |
| code | 1..1 | code | Symbol in syntax defined by the system | |
 display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| subject | 0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of | |
| encounter | 0..1 | Reference(Encounter) | Encounter associated with media | |
| operator | 0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image | |
 content | S | 1..1 | Attachment | Actual Media - reference or data |
 contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
| data | S | 1..1 | base64Binary | Data inline, base64ed |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Identifier(s) for the image | ||||
| basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
| partOf | Σ | 0..* | Reference(Resource) | Part of referenced event | ||||
| status | ?!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. | ||||
| type | Σ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
| modality | 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. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
| subject | Σ | 0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
 created[x] | Σ | 0..1 | When Media was collected | |||||
| createdDateTime | dateTime | |||||||
| createdPeriod | Period | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| operator | Σ | 0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
| bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| deviceName | Σ | 0..1 | string | Name of the device/manufacturer | ||||
| device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
| height | Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
| width | Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
| frames | Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
| duration | Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
| content | SΣ | 1..1 | Attachment | Actual Media - reference or data | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | 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 | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | S | 1..1 | base64Binary | Data inline, base64ed | ||||
| url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| note | 0..* | Annotation | Comments made about the media | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| status | ?!Σ | 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. |
| modality | Σ | 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. |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| content | Σ | 1..1 | Attachment | Actual Media - reference or data |
| contentType | Σ | 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. |
| data | 1..1 | base64Binary | Data inline, base64ed | |
| Documentation for this format | ||||
This structure is derived from Media
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| basedOn | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | |
| status | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
| modality | S | 0..1 | CodeableConcept | The type of acquisition equipment/process |
| coding | S | 0..* | Coding | Code defined by a terminology system |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| subject | 0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of | |
| encounter | 0..1 | Reference(Encounter) | Encounter associated with media | |
| operator | 0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image | |
| content | S | 1..1 | Attachment | Actual Media - reference or data |
| contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
| data | S | 1..1 | base64Binary | Data inline, base64ed |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Identifier(s) for the image | ||||
| basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
| partOf | Σ | 0..* | Reference(Resource) | Part of referenced event | ||||
| status | ?!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. | ||||
| type | Σ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
| modality | 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. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
| subject | Σ | 0..1 | Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole) | Who/What this Media is a record of | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
| created[x] | Σ | 0..1 | When Media was collected | |||||
| createdDateTime | dateTime | |||||||
| createdPeriod | Period | |||||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| operator | Σ | 0..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | The person who generated the image | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
| bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| deviceName | Σ | 0..1 | string | Name of the device/manufacturer | ||||
| device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
| height | Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
| width | Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
| frames | Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
| duration | Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
| content | SΣ | 1..1 | Attachment | Actual Media - reference or data | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | 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 | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | S | 1..1 | base64Binary | Data inline, base64ed | ||||
| url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| note | 0..* | Annotation | Comments made about the media | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Media.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Media.status | required | EventStatus |
| Media.type | extensible | MediaType |
| Media.modality | example | MediaModality |
| Media.view | example | MediaCollectionView/Projection |
| Media.reasonCode | example | ProcedureReasonCodes |
| Media.bodySite | example | SNOMEDCTBodyStructures |
| Media.content.contentType | required | Mime Types |
| Media.content.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Id | Grade | Path | 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 | Media.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Media.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Media.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Media.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Media.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.modality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.modality.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Media.modality.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Media.modality.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.modality.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Media.modality.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Media.modality.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.modality.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.modality.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.modality.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.modality.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.modality.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.view | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.created[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.issued | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.operator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.deviceName | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.device | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.height | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.width | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.frames | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.duration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.content.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Media.content.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Media.content.contentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.content.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.content.data | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.content.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.content.size | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.content.hash | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.content.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.content.creation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Media.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |