FHIR Implementation Guide for NDHM CI Build v2.0
banner

NDHM (R4), Published and maintained by NRCeS for NHA.
This version is based on the NDHM Health Data Interchange Specifications 1.0 and updated periodically.

StructureDefinition-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.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://nrces.in/ndhm/fhir/r4/StructureDefinition/Media

This profile builds on Media

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 7 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... status S1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... modality S0..1CodeableConceptThe type of acquisition equipment/process
.... coding S0..*CodingCode defined by a terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... subject 0..1Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole)Who/What this Media is a record of
... operator 0..1Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient)The person who generated the image
... content S1..1AttachmentActual Media - reference or data
.... contentType S1..1codeMime type of the content, with charset etc.
.... data S1..1base64BinaryData inline, base64ed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Media I0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifier(s) for the image
... basedOn ΣI0..*Reference(ServiceRequest | CarePlan)Procedure that caused this media to be created
... partOf ΣI0..*Reference(Resource)Part of referenced event
... status ?!SΣI1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... type ΣI0..1CodeableConceptClassification of media as image, video, or audio
Binding: MediaType (extensible)
... modality SΣI0..1CodeableConceptThe type of acquisition equipment/process
Binding: MediaModality (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... view ΣI0..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: MediaCollectionView/Projection (example)
... subject ΣI0..1Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole)Who/What this Media is a record of
... encounter ΣI0..1Reference(Encounter)Encounter associated with media
... created[x] ΣI0..1When Media was collected
.... createdDateTimedateTime
.... createdPeriodPeriod
... issued ΣI0..1instantDate/Time this version was made available
... operator ΣI0..1Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient)The person who generated the image
... reasonCode ΣI0..*CodeableConceptWhy was event performed?
Binding: ProcedureReasonCodes (example)
... bodySite ΣI0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... deviceName ΣI0..1stringName of the device/manufacturer
... device ΣI0..1Reference(Device | DeviceMetric | Device)Observing Device
... height ΣI0..1positiveIntHeight of the image in pixels (photo/video)
... width ΣI0..1positiveIntWidth of the image in pixels (photo/video)
... frames ΣI0..1positiveIntNumber of frames if > 1 (photo)
... duration ΣI0..1decimalLength in seconds (audio / video)
... content SΣI1..1AttachmentActual Media - reference or data
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType SΣI1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
Example General: text/plain; charset=UTF-8, image/png
.... language ΣI0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
Example General: en-AU
.... data SI1..1base64BinaryData inline, base64ed
.... url ΣI0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size ΣI0..1unsignedIntNumber of bytes of content (if url provided)
.... hash ΣI0..1base64BinaryHash of the data (sha-1, base64ed)
.... title ΣI0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... creation ΣI0..1dateTimeDate attachment was first created
... note I0..*AnnotationComments made about the media

doco Documentation for this format

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 7 elements

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... status S1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... modality S0..1CodeableConceptThe type of acquisition equipment/process
.... coding S0..*CodingCode defined by a terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... subject 0..1Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole)Who/What this Media is a record of
... operator 0..1Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient)The person who generated the image
... content S1..1AttachmentActual Media - reference or data
.... contentType S1..1codeMime type of the content, with charset etc.
.... data S1..1base64BinaryData inline, base64ed

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media I0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifier(s) for the image
... basedOn ΣI0..*Reference(ServiceRequest | CarePlan)Procedure that caused this media to be created
... partOf ΣI0..*Reference(Resource)Part of referenced event
... status ?!SΣI1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... type ΣI0..1CodeableConceptClassification of media as image, video, or audio
Binding: MediaType (extensible)
... modality SΣI0..1CodeableConceptThe type of acquisition equipment/process
Binding: MediaModality (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... view ΣI0..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: MediaCollectionView/Projection (example)
... subject ΣI0..1Reference(Group | Device | Location | Patient | Specimen | Practitioner | PractitionerRole)Who/What this Media is a record of
... encounter ΣI0..1Reference(Encounter)Encounter associated with media
... created[x] ΣI0..1When Media was collected
.... createdDateTimedateTime
.... createdPeriodPeriod
... issued ΣI0..1instantDate/Time this version was made available
... operator ΣI0..1Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient)The person who generated the image
... reasonCode ΣI0..*CodeableConceptWhy was event performed?
Binding: ProcedureReasonCodes (example)
... bodySite ΣI0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example)
... deviceName ΣI0..1stringName of the device/manufacturer
... device ΣI0..1Reference(Device | DeviceMetric | Device)Observing Device
... height ΣI0..1positiveIntHeight of the image in pixels (photo/video)
... width ΣI0..1positiveIntWidth of the image in pixels (photo/video)
... frames ΣI0..1positiveIntNumber of frames if > 1 (photo)
... duration ΣI0..1decimalLength in seconds (audio / video)
... content SΣI1..1AttachmentActual Media - reference or data
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType SΣI1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
Example General: text/plain; charset=UTF-8, image/png
.... language ΣI0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
Example General: en-AU
.... data SI1..1base64BinaryData inline, base64ed
.... url ΣI0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size ΣI0..1unsignedIntNumber of bytes of content (if url provided)
.... hash ΣI0..1base64BinaryHash of the data (sha-1, base64ed)
.... title ΣI0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... creation ΣI0..1dateTimeDate attachment was first created
... note I0..*AnnotationComments made about the media

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron