Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Media | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_Media_R4B | ||
This cross-version profile allows STU3 Media content to be represented via FHIR R4B Media resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| 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. |
  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:content |
1..1 | Attachment | STU3: content additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.content Constraints: ext-1 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.status | Base | required | EventStatus | 📍4.3.0 | FHIR Std. |
| 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.modifierExtension, Media.status, Media.content, Media.content.extension, Media.content.extension:content | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Media.modifierExtension, Media.content.extension, Media.content.extension:content | 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 Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
 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:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
 tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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
| |||||
| 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 | |||||
| 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:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
| 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:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| 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) | STU3: basedOn 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 | ||||
| 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. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
1..1 | code | STU3: photo | video | audio URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.type Binding: MediaType (required): Whether the media is a photo, video, or audio Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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) | STU3: subject 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 | ||||
| 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:context |
0..1 | Reference(Resource) | STU3: Encounter / Episode associated with media 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 | ||||
 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 | ||||
| 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:operator |
0..1 | Reference(Resource) | STU3: operator 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 | ||||
| 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 | ||||
| deviceName |
Σ | 0..1 | string | Name of the device/manufacturer | ||||
| device |
Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
| 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:device |
0..1 | Reference(Resource) | STU3: device 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 | ||||
| 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:content |
1..1 | Attachment | STU3: content additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.content 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
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 | |||||
| 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:note |
0..* | Annotation | STU3: note additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Media.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Media.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Media.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Media.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Media.identifier.type | Base | extensible | IdentifierType | 📍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.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Media.operator.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.device.type | Base | extensible | ResourceType | 📍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. |
| 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.meta.extension, Media.meta.extension:meta, Media.meta.versionId, Media.meta.lastUpdated, Media.meta.source, Media.meta.profile, Media.meta.security, Media.meta.tag, Media.implicitRules, Media.language, Media.text, Media.text.extension, Media.text.extension:text, Media.text.status, Media.text.div, Media.extension, Media.modifierExtension, Media.identifier, Media.identifier.extension, Media.identifier.extension:identifier, Media.identifier.use, Media.identifier.type, Media.identifier.system, Media.identifier.value, Media.identifier.period, Media.identifier.assigner, 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.type.extension, Media.type.extension:type, Media.type.coding, Media.type.text, 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.encounter.extension, Media.encounter.extension:context, Media.encounter.reference, Media.encounter.type, Media.encounter.identifier, Media.encounter.display, Media.created[x], Media.issued, Media.operator, Media.operator.extension, Media.operator.extension:operator, Media.operator.reference, Media.operator.type, Media.operator.identifier, Media.operator.display, Media.reasonCode, Media.bodySite, Media.deviceName, Media.device, Media.device.extension, Media.device.extension:device, Media.device.reference, Media.device.type, Media.device.identifier, Media.device.display, Media.height, Media.width, Media.frames, Media.duration, Media.content, Media.content.extension, Media.content.extension:content, 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, Media.note.extension, Media.note.extension:note, Media.note.author[x], Media.note.time, Media.note.text | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Media.meta.extension, Media.meta.extension:meta, Media.text.extension, Media.text.extension:text, Media.extension, Media.modifierExtension, Media.identifier.extension, Media.identifier.extension:identifier, Media.basedOn.extension, Media.basedOn.extension:basedOn, Media.type.extension, Media.type.extension:type, Media.subject.extension, Media.subject.extension:subject, Media.encounter.extension, Media.encounter.extension:context, Media.operator.extension, Media.operator.extension:operator, Media.device.extension, Media.device.extension:device, Media.content.extension, Media.content.extension:content, Media.note.extension, Media.note.extension:note | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Media.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Media.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Media
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| 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. |
| 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:content |
1..1 | Attachment | STU3: content additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.content Constraints: ext-1 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.status | Base | required | EventStatus | 📍4.3.0 | FHIR Std. |
| 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.modifierExtension, Media.status, Media.content, Media.content.extension, Media.content.extension:content | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Media.modifierExtension, Media.content.extension, Media.content.extension:content | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Media
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| 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:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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
| |||||
| 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 | |||||
| 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:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
| 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:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| 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) | STU3: basedOn 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 | ||||
| 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. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
1..1 | code | STU3: photo | video | audio URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.type Binding: MediaType (required): Whether the media is a photo, video, or audio Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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) | STU3: subject 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 | ||||
| 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:context |
0..1 | Reference(Resource) | STU3: Encounter / Episode associated with media 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 | ||||
| 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 | ||||
| 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:operator |
0..1 | Reference(Resource) | STU3: operator 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 | ||||
| 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 | ||||
| deviceName |
Σ | 0..1 | string | Name of the device/manufacturer | ||||
| device |
Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
| 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:device |
0..1 | Reference(Resource) | STU3: device 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 | ||||
| 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:content |
1..1 | Attachment | STU3: content additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.content 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
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 | |||||
| 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:note |
0..* | Annotation | STU3: note additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Media.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Media.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Media.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Media.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Media.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Media.identifier.type | Base | extensible | IdentifierType | 📍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.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Media.operator.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.device.type | Base | extensible | ResourceType | 📍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. |
| 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.meta.extension, Media.meta.extension:meta, Media.meta.versionId, Media.meta.lastUpdated, Media.meta.source, Media.meta.profile, Media.meta.security, Media.meta.tag, Media.implicitRules, Media.language, Media.text, Media.text.extension, Media.text.extension:text, Media.text.status, Media.text.div, Media.extension, Media.modifierExtension, Media.identifier, Media.identifier.extension, Media.identifier.extension:identifier, Media.identifier.use, Media.identifier.type, Media.identifier.system, Media.identifier.value, Media.identifier.period, Media.identifier.assigner, 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.type.extension, Media.type.extension:type, Media.type.coding, Media.type.text, 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.encounter.extension, Media.encounter.extension:context, Media.encounter.reference, Media.encounter.type, Media.encounter.identifier, Media.encounter.display, Media.created[x], Media.issued, Media.operator, Media.operator.extension, Media.operator.extension:operator, Media.operator.reference, Media.operator.type, Media.operator.identifier, Media.operator.display, Media.reasonCode, Media.bodySite, Media.deviceName, Media.device, Media.device.extension, Media.device.extension:device, Media.device.reference, Media.device.type, Media.device.identifier, Media.device.display, Media.height, Media.width, Media.frames, Media.duration, Media.content, Media.content.extension, Media.content.extension:content, 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, Media.note.extension, Media.note.extension:note, Media.note.author[x], Media.note.time, Media.note.text | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Media.meta.extension, Media.meta.extension:meta, Media.text.extension, Media.text.extension:text, Media.extension, Media.modifierExtension, Media.identifier.extension, Media.identifier.extension:identifier, Media.basedOn.extension, Media.basedOn.extension:basedOn, Media.type.extension, Media.type.extension:type, Media.subject.extension, Media.subject.extension:subject, Media.encounter.extension, Media.encounter.extension:context, Media.operator.extension, Media.operator.extension:operator, Media.device.extension, Media.device.extension:device, Media.content.extension, Media.content.extension:content, Media.note.extension, Media.note.extension:note | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Media.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Media.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Media
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r3.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
