Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_DocumentReference_R4B_Media

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-DocumentReference-for-Media Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_DocumentReference_R4B_Media

This cross-version profile allows R5 DocumentReference content to be represented via FHIR R4B Media resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* Media(4.3.0) A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
Constraints: ext-1
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... content Σ 1..1 Attachment Actual Media - reference or data
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Media.status Base required EventStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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.implicitRules, Media.extension, Media.extension:version, Media.extension:attester, Media.modifierExtension, Media.status, Media.content, Media.content.extension, Media.content.extension:profile All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Media.extension, Media.extension:version, Media.extension:attester, Media.modifierExtension, Media.content.extension, Media.content.extension:profile Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* Media(4.3.0) A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* Reference(Resource) R5: basedOn
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:bodySite 0..* Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B(0.1.0) | BodyStructure) R5: Body part included additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.bodySite
... content
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* Media(4.3.0) 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): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
Constraints: ext-1
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier(s) for the image
... basedOn Σ 0..* Reference(ServiceRequest | CarePlan) Procedure that caused this media to be created
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:basedOn 0..1 Reference(Resource) R5: basedOn
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Resource) Part of referenced event
... 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.
... type Σ 0..1 CodeableConcept Classification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.
... 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.
... 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(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) Who/What this Media is a record of
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) 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): SNOMED CT Body site concepts
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:bodySite 0..* Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B(0.1.0) | BodyStructure) R5: Body part included additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.bodySite
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... 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 Σ 1..1 Attachment Actual Media - reference or data
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
.... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 0..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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Media.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Media.basedOn.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Media.status Base required EventStatus 📍4.3.0 FHIR Std.
Media.type Base extensible Media Type 📍4.3.0 FHIR Std.
Media.modality Base example Media Modality 📍4.3.0 FHIR Std.
Media.view Base example Media Collection View/Projection 📍4.3.0 FHIR Std.
Media.subject.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Media.reasonCode Base example Procedure Reason Codes 📍4.3.0 FHIR Std.
Media.bodySite Base example SNOMED CT Body Structures 📍4.3.0 FHIR Std.
Media.content.contentType Base required MimeType 📍4.3.0 FHIR Std.
Media.content.language Base preferred Common Languages 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Media.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Media.meta, Media.implicitRules, Media.language, Media.text, Media.extension, Media.extension:version, Media.extension:attester, Media.modifierExtension, Media.identifier, Media.basedOn, Media.basedOn.extension, Media.basedOn.extension:basedOn, Media.basedOn.reference, Media.basedOn.type, Media.basedOn.identifier, Media.basedOn.display, Media.partOf, Media.status, Media.type, Media.modality, Media.view, Media.subject, Media.subject.extension, Media.subject.extension:subject, Media.subject.reference, Media.subject.type, Media.subject.identifier, Media.subject.display, Media.encounter, Media.created[x], Media.issued, Media.operator, Media.reasonCode, Media.bodySite, Media.bodySite.extension, Media.bodySite.extension:bodySite, Media.bodySite.coding, Media.bodySite.text, Media.deviceName, Media.device, Media.height, Media.width, Media.frames, Media.duration, Media.content, Media.content.extension, Media.content.extension:profile, Media.content.contentType, Media.content.language, Media.content.data, Media.content.url, Media.content.size, Media.content.hash, Media.content.title, Media.content.creation, Media.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Media.extension, Media.extension:version, Media.extension:attester, Media.modifierExtension, Media.basedOn.extension, Media.basedOn.extension:basedOn, Media.subject.extension, Media.subject.extension:subject, Media.bodySite.extension, Media.bodySite.extension:bodySite, Media.content.extension, Media.content.extension:profile Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* Media(4.3.0) A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
Constraints: ext-1
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... content Σ 1..1 Attachment Actual Media - reference or data
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Media.status Base required EventStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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.implicitRules, Media.extension, Media.extension:version, Media.extension:attester, Media.modifierExtension, Media.status, Media.content, Media.content.extension, Media.content.extension:profile All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Media.extension, Media.extension:version, Media.extension:attester, Media.modifierExtension, Media.content.extension, Media.content.extension:profile Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* Media(4.3.0) A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* Reference(Resource) R5: basedOn
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:bodySite 0..* Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B(0.1.0) | BodyStructure) R5: Body part included additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.bodySite
... content
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* Media(4.3.0) 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): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
Constraints: ext-1
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier(s) for the image
... basedOn Σ 0..* Reference(ServiceRequest | CarePlan) Procedure that caused this media to be created
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:basedOn 0..1 Reference(Resource) R5: basedOn
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Resource) Part of referenced event
... 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.
... type Σ 0..1 CodeableConcept Classification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.
... 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.
... 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(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) Who/What this Media is a record of
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) 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): SNOMED CT Body site concepts
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:bodySite 0..* Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B(0.1.0) | BodyStructure) R5: Body part included additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.bodySite
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... 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 Σ 1..1 Attachment Actual Media - reference or data
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
.... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 0..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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Media.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Media.basedOn.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Media.status Base required EventStatus 📍4.3.0 FHIR Std.
Media.type Base extensible Media Type 📍4.3.0 FHIR Std.
Media.modality Base example Media Modality 📍4.3.0 FHIR Std.
Media.view Base example Media Collection View/Projection 📍4.3.0 FHIR Std.
Media.subject.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Media.reasonCode Base example Procedure Reason Codes 📍4.3.0 FHIR Std.
Media.bodySite Base example SNOMED CT Body Structures 📍4.3.0 FHIR Std.
Media.content.contentType Base required MimeType 📍4.3.0 FHIR Std.
Media.content.language Base preferred Common Languages 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Media.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Media.meta, Media.implicitRules, Media.language, Media.text, Media.extension, Media.extension:version, Media.extension:attester, Media.modifierExtension, Media.identifier, Media.basedOn, Media.basedOn.extension, Media.basedOn.extension:basedOn, Media.basedOn.reference, Media.basedOn.type, Media.basedOn.identifier, Media.basedOn.display, Media.partOf, Media.status, Media.type, Media.modality, Media.view, Media.subject, Media.subject.extension, Media.subject.extension:subject, Media.subject.reference, Media.subject.type, Media.subject.identifier, Media.subject.display, Media.encounter, Media.created[x], Media.issued, Media.operator, Media.reasonCode, Media.bodySite, Media.bodySite.extension, Media.bodySite.extension:bodySite, Media.bodySite.coding, Media.bodySite.text, Media.deviceName, Media.device, Media.height, Media.width, Media.frames, Media.duration, Media.content, Media.content.extension, Media.content.extension:profile, Media.content.contentType, Media.content.language, Media.content.data, Media.content.url, Media.content.size, Media.content.hash, Media.content.title, Media.content.creation, Media.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Media.extension, Media.extension:version, Media.extension:attester, Media.modifierExtension, Media.basedOn.extension, Media.basedOn.extension:basedOn, Media.subject.extension, Media.subject.extension:subject, Media.bodySite.extension, Media.bodySite.extension:bodySite, Media.content.extension, Media.content.extension:profile Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron