Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| 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_R3_Media | ||
This cross-version profile allows R5 DocumentReference content to be represented via FHIR STU3 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference Constraints: mda-1, mda-2, mda-3, mda-4 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
0..* | (Complex) | R5: Attests to accuracy of the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 1..1 | code | photo | video | audio Binding: DigitalMediaType (required): Whether the media is a photo, video, or audio |
![]() ![]() |
1..1 | Attachment | Actual Media - reference or data | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | R5: Content profile rules for the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.type | Base | required | DigitalMediaType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Media | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mda-1 | error | Media | Height can only be used for a photo or video |
height.empty() or type != 'audio'
|
| mda-2 | error | Media | Width can only be used for a photo or video |
width.empty() or type != 'audio'
|
| mda-3 | error | Media | Frames can only be used for a photo |
frames.empty() or type = 'photo'
|
| mda-4 | error | Media | Duration can only be used for an audio or a video |
duration.empty() or type != 'photo'
|
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
0..* | (Complex) | R5: Attests to accuracy of the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: basedOn URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Who/what is the subject of the document additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3(0.1.0) | BodySite) | R5: Body part included additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.bodySite | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | R5: Content profile rules for the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference Constraints: mda-1, mda-2, mda-3, mda-4 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | (Complex) | R5: Attests to accuracy of the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
![]() ![]() |
Σ | 0..* | Reference(ProcedureRequest) | Procedure that caused this media to be created | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: basedOn URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 1..1 | code | photo | video | audio Binding: DigitalMediaType (required): Whether the media is a photo, video, or audio | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: Media SubType (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: Media Collection View/Projection (example): Imaging view (projection) used when collecting an image | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | Group | Device | Specimen) | Who/What this Media is a record of | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Who/what is the subject of the document additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with media | ||||
![]() ![]() |
Σ | 0..1 | When Media was collected | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner) | The person who generated the image | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Why was event performed? Binding: Procedure Reason Codes (example): The reason for the media | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Body part in media Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3(0.1.0) | BodySite) | R5: Body part included additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.bodySite | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | Reference(Device | DeviceMetric) | Observing Device | ||||
![]() ![]() |
ΣC | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
![]() ![]() |
ΣC | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
![]() ![]() |
ΣC | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
![]() ![]() |
ΣC | 0..1 | unsignedInt | Length in seconds (audio / video) | ||||
![]() ![]() |
1..1 | Attachment | Actual Media - reference or data | |||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | R5: Content profile rules for the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() |
0..* | Annotation | Comments made about the media | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Media.type | Base | required | DigitalMediaType | 📍3.0.2 | FHIR Std. |
| Media.subtype | Base | example | Media SubType | 📍3.0.2 | FHIR Std. |
| Media.view | Base | example | Media Collection View/Projection | 📍3.0.2 | FHIR Std. |
| Media.reasonCode | Base | example | Procedure Reason Codes | 📍3.0.2 | FHIR Std. |
| Media.bodySite | Base | example | SNOMED CT Body Structures | 📍3.0.2 | FHIR Std. |
| Media.content.contentType | Base | required | null (missing link) | 📦 | unknown? |
| Media.content.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Media | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mda-1 | error | Media | Height can only be used for a photo or video |
height.empty() or type != 'audio'
|
| mda-2 | error | Media | Width can only be used for a photo or video |
width.empty() or type != 'audio'
|
| mda-3 | error | Media | Frames can only be used for a photo |
frames.empty() or type = 'photo'
|
| mda-4 | error | Media | Duration can only be used for an audio or a video |
duration.empty() or type != 'photo'
|
This structure is derived from Media
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference Constraints: mda-1, mda-2, mda-3, mda-4 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
0..* | (Complex) | R5: Attests to accuracy of the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 1..1 | code | photo | video | audio Binding: DigitalMediaType (required): Whether the media is a photo, video, or audio |
![]() ![]() |
1..1 | Attachment | Actual Media - reference or data | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | R5: Content profile rules for the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.type | Base | required | DigitalMediaType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Media | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mda-1 | error | Media | Height can only be used for a photo or video |
height.empty() or type != 'audio'
|
| mda-2 | error | Media | Width can only be used for a photo or video |
width.empty() or type != 'audio'
|
| mda-3 | error | Media | Frames can only be used for a photo |
frames.empty() or type = 'photo'
|
| mda-4 | error | Media | Duration can only be used for an audio or a video |
duration.empty() or type != 'photo'
|
Differential View
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
0..* | (Complex) | R5: Attests to accuracy of the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: basedOn URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Who/what is the subject of the document additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3(0.1.0) | BodySite) | R5: Body part included additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.bodySite | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | R5: Content profile rules for the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference Constraints: mda-1, mda-2, mda-3, mda-4 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | (Complex) | R5: Attests to accuracy of the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
![]() ![]() |
Σ | 0..* | Reference(ProcedureRequest) | Procedure that caused this media to be created | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: basedOn URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 1..1 | code | photo | video | audio Binding: DigitalMediaType (required): Whether the media is a photo, video, or audio | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: Media SubType (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: Media Collection View/Projection (example): Imaging view (projection) used when collecting an image | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | Group | Device | Specimen) | Who/What this Media is a record of | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Who/what is the subject of the document additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with media | ||||
![]() ![]() |
Σ | 0..1 | When Media was collected | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner) | The person who generated the image | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Why was event performed? Binding: Procedure Reason Codes (example): The reason for the media | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Body part in media Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Cross-version Profile for R5.BodyStructure for use in FHIR STU3(0.1.0) | BodySite) | R5: Body part included additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.bodySite | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | Reference(Device | DeviceMetric) | Observing Device | ||||
![]() ![]() |
ΣC | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
![]() ![]() |
ΣC | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
![]() ![]() |
ΣC | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
![]() ![]() |
ΣC | 0..1 | unsignedInt | Length in seconds (audio / video) | ||||
![]() ![]() |
1..1 | Attachment | Actual Media - reference or data | |||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | R5: Content profile rules for the document (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: Common Languages (extensible): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() |
0..* | Annotation | Comments made about the media | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Media.type | Base | required | DigitalMediaType | 📍3.0.2 | FHIR Std. |
| Media.subtype | Base | example | Media SubType | 📍3.0.2 | FHIR Std. |
| Media.view | Base | example | Media Collection View/Projection | 📍3.0.2 | FHIR Std. |
| Media.reasonCode | Base | example | Procedure Reason Codes | 📍3.0.2 | FHIR Std. |
| Media.bodySite | Base | example | SNOMED CT Body Structures | 📍3.0.2 | FHIR Std. |
| Media.content.contentType | Base | required | null (missing link) | 📦 | unknown? |
| Media.content.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Media | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mda-1 | error | Media | Height can only be used for a photo or video |
height.empty() or type != 'audio'
|
| mda-2 | error | Media | Width can only be used for a photo or video |
width.empty() or type != 'audio'
|
| mda-3 | error | Media | Frames can only be used for a photo |
frames.empty() or type = 'photo'
|
| mda-4 | error | Media | Duration can only be used for an audio or a video |
duration.empty() or type != 'photo'
|
This structure is derived from Media
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron