Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Draft as of 2024-09-12 |
Definitions for the dh-media-core-1 resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Media | |
Invariants | inv-dh-media-02: If present, an operator shall at least have a reference, an identifier or a display (operator.exists() implies operator.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) ) |
2. Media.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
4. Media.status | |
Pattern Value | completed |
6. Media.type | |
Control | 1..? |
Must Support | true |
8. Media.modality | |
Must Support | true |
10. Media.subject | |
Control | 1..? This element is affected by the following invariants: inv-dh-media-01 |
Type | Reference(ADHA Core Patient) |
Must Support | true |
Invariants | inv-dh-media-01: At least reference or a valid identifier shall be present (reference.exists() or identifier.where(system.count() + value.count() >1).exists() ) |
12. Media.created[x] | |
Control | 1..? This element is affected by the following invariants: inv-dh-media-03 |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Must Support | true |
Invariants | inv-dh-media-03: Date shall be at least to day ($this is DateTime implies $this.toString().length() >= 10 ) |
14. Media.issued | |
Must Support | true |
16. Media.operator | |
Type | Reference(ADHA Core PractitionerRole, ADHA Core Organization, ADHA Core Patient, ADHA System Device, ADHA Core RelatedPerson) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
18. Media.content | |
Comments | Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching. The set of MIME types allowed as attachments in the My Health Record system may be limited to: image/jpeg, image/png, image/tiff, image/gif, application/pdf. |
Must Support | true |
20. Media.note | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. Media | |
Definition | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. |
Short | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference |
Control | 0..* |
Is Modifier | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) inv-dh-media-02: If present, an operator shall at least have a reference, an identifier or a display ( operator.exists() implies operator.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) ) |
2. Media.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Media.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
6. Media.identifier | |
Definition | Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. |
Short | Identifier(s) for the image |
Comments | The identifier label and use can be used to determine what kind of identifier it is. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. Media.status | |
Definition | The current state of the {{title}}. |
Short | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
Comments | A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
Control | 1..1 |
Binding | The codes SHALL be taken from EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/event-status|4.0.1 )Codes identifying the lifecycle stage of an event. |
Type | code |
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Pattern Value | completed |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. Media.type | |
Definition | A code that classifies whether the media is an image, video or audio recording or some other media category. |
Short | Classification of media as image, video, or audio |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from MediaTypehttp://hl7.org/fhir/ValueSet/media-type (extensible to http://hl7.org/fhir/ValueSet/media-type )Codes for high level media categories. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Used for filtering what observations are retrieved and displayed. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. Media.modality | |
Definition | Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality. |
Short | The type of acquisition equipment/process |
Control | 0..1 |
Binding | For example codes, see MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality (example to http://hl7.org/fhir/ValueSet/media-modality )Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. Media.subject | |
Definition | Who/What this Media is a record of. |
Short | Who/What this Media is a record of |
Control | 10..1 This element is affected by the following invariants: inv-dh-media-01 |
Type | Reference(ADHA Core Patient, Patient, Practitioner, PractitionerRole, Group, Device, Specimen, Location) |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-dh-media-01: At least reference or a valid identifier shall be present ( reference.exists() or identifier.where(system.count() + value.count() >1).exists() ) |
16. Media.created[x] | |
Definition | The date and time(s) at which the media was collected. |
Short | When Media was collected |
Control | 10..1 This element is affected by the following invariants: inv-dh-media-03 |
Type | Choice of: dateTime, Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Alternate Names | timing |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-dh-media-03: Date shall be at least to day ( $this is DateTime implies $this.toString().length() >= 10 ) |
18. Media.issued | |
Definition | The date and time this version of the media was made available to providers, typically after having been reviewed. |
Short | Date/Time this version was made available |
Comments | It may be the same as the |
Control | 0..1 |
Type | instant |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. Media.operator | |
Definition | The person who administered the collection of the image. |
Short | The person who generated the image |
Control | 0..1 This element is affected by the following invariants: inv-dh-media-02 |
Type | Reference(ADHA Core PractitionerRole, ADHA Core Organization, ADHA Core Patient, ADHA System Device, ADHA Core RelatedPerson, Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. Media.content | |
Definition | The actual content of the media - inline or by direct reference to the media source file. |
Short | Actual Media - reference or data |
Comments | Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching. The set of MIME types allowed as attachments in the My Health Record system may be limited to: image/jpeg, image/png, image/tiff, image/gif, application/pdf. Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching. |
Control | 1..1 |
Type | Attachment |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. Media.note | |
Definition | Comments made about the media by the performer, subject or other participants. |
Short | Comments made about the media |
Comments | Not to be used for observations, conclusions, etc. Instead use an Observation based on the Media/ImagingStudy resource. |
Control | 0..* |
Type | Annotation |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. Media | |||||
Definition | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. | ||||
Short | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() )inv-dh-media-02: If present, an operator shall at least have a reference, an identifier or a display ( operator.exists() implies operator.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) ) | ||||
2. Media.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. Media.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. Media.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
8. Media.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. Media.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. Media.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. Media.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
16. Media.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. Media.identifier | |||||
Definition | Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. | ||||
Short | Identifier(s) for the image | ||||
Comments | The identifier label and use can be used to determine what kind of identifier it is. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
20. Media.basedOn | |||||
Definition | A procedure that is fulfilled in whole or in part by the creation of this media. | ||||
Short | Procedure that caused this media to be created | ||||
Control | 0..* | ||||
Type | Reference(ServiceRequest, CarePlan) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. | ||||
Alternate Names | fulfills | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
22. Media.partOf | |||||
Definition | A larger event of which this particular event is a component or step. | ||||
Short | Part of referenced event | ||||
Comments | Not to be used to link an event to an Encounter - use Media.encounter for that. [The allowed reference resources may be adjusted as appropriate for the event resource]. | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | E.g. Drug administration as part of a procedure, procedure as part of observation, etc. | ||||
Alternate Names | container | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. Media.status | |||||
Definition | The current state of the {{title}}. | ||||
Short | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown | ||||
Comments | A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from EventStatus (required to http://hl7.org/fhir/ValueSet/event-status|4.0.1 )Codes identifying the lifecycle stage of an event. | ||||
Type | code | ||||
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Pattern Value | completed | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. Media.type | |||||
Definition | A code that classifies whether the media is an image, video or audio recording or some other media category. | ||||
Short | Classification of media as image, video, or audio | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from MediaType (extensible to http://hl7.org/fhir/ValueSet/media-type )Codes for high level media categories. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Used for filtering what observations are retrieved and displayed. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. Media.modality | |||||
Definition | Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality. | ||||
Short | The type of acquisition equipment/process | ||||
Control | 0..1 | ||||
Binding | For example codes, see MediaModality (example to http://hl7.org/fhir/ValueSet/media-modality )Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. Media.view | |||||
Definition | The name of the imaging view e.g. Lateral or Antero-posterior (AP). | ||||
Short | Imaging view, e.g. Lateral or Antero-posterior | ||||
Control | 0..1 | ||||
Binding | For example codes, see MediaCollectionView/Projection (example to http://hl7.org/fhir/ValueSet/media-view )Imaging view (projection) used when collecting an image. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. Media.subject | |||||
Definition | Who/What this Media is a record of. | ||||
Short | Who/What this Media is a record of | ||||
Control | 1..1 This element is affected by the following invariants: inv-dh-media-01 | ||||
Type | Reference(ADHA Core Patient) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )inv-dh-media-01: At least reference or a valid identifier shall be present ( reference.exists() or identifier.where(system.count() + value.count() >1).exists() ) | ||||
34. Media.encounter | |||||
Definition | The encounter that establishes the context for this media. | ||||
Short | Encounter associated with media | ||||
Comments | This will typically be the encounter the media occurred within. | ||||
Control | 0..1 | ||||
Type | Reference(Encounter) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Links the Media to the Encounter context. | ||||
Alternate Names | context | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. Media.created[x] | |||||
Definition | The date and time(s) at which the media was collected. | ||||
Short | When Media was collected | ||||
Control | 1..1 This element is affected by the following invariants: inv-dh-media-03 | ||||
Type | Choice of: dateTime, Period | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
Alternate Names | timing | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )inv-dh-media-03: Date shall be at least to day ( $this is DateTime implies $this.toString().length() >= 10 ) | ||||
38. Media.issued | |||||
Definition | The date and time this version of the media was made available to providers, typically after having been reviewed. | ||||
Short | Date/Time this version was made available | ||||
Comments | It may be the same as the | ||||
Control | 0..1 | ||||
Type | instant | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
40. Media.operator | |||||
Definition | The person who administered the collection of the image. | ||||
Short | The person who generated the image | ||||
Control | 0..1 This element is affected by the following invariants: inv-dh-media-02 | ||||
Type | Reference(ADHA Core PractitionerRole, ADHA Core Organization, ADHA Core Patient, ADHA System Device, ADHA Core RelatedPerson) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. Media.reasonCode | |||||
Definition | Describes why the event occurred in coded or textual form. | ||||
Short | Why was event performed? | ||||
Comments | Textual reasons can be captured using reasonCode.text. | ||||
Control | 0..* | ||||
Binding | For example codes, see ProcedureReasonCodes (example to http://hl7.org/fhir/ValueSet/procedure-reason )The reason for the media. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. Media.bodySite | |||||
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). | ||||
Short | Observed body part | ||||
Comments | Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite. | ||||
Control | 0..1 | ||||
Binding | For example codes, see SNOMEDCTBodyStructures (example to http://hl7.org/fhir/ValueSet/body-site )Codes describing anatomical locations. May include laterality. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
46. Media.deviceName | |||||
Definition | The name of the device / manufacturer of the device that was used to make the recording. | ||||
Short | Name of the device/manufacturer | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
48. Media.device | |||||
Definition | The device used to collect the media. | ||||
Short | Observing Device | ||||
Comments | An extension should be used if further typing of the device is needed. Secondary devices used to support collecting a media can be represented using either extension or through the Observation.related element. | ||||
Control | 0..1 | ||||
Type | Reference(Device, DeviceMetric, Device) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
50. Media.height | |||||
Definition | Height of the image in pixels (photo/video). | ||||
Short | Height of the image in pixels (photo/video) | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. Media.width | |||||
Definition | Width of the image in pixels (photo/video). | ||||
Short | Width of the image in pixels (photo/video) | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. Media.frames | |||||
Definition | The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. | ||||
Short | Number of frames if > 1 (photo) | ||||
Comments | if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated. | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. Media.duration | |||||
Definition | The duration of the recording in seconds - for audio and video. | ||||
Short | Length in seconds (audio / video) | ||||
Comments | The duration might differ from occurrencePeriod if recording was paused. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. Media.content | |||||
Definition | The actual content of the media - inline or by direct reference to the media source file. | ||||
Short | Actual Media - reference or data | ||||
Comments | Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching. The set of MIME types allowed as attachments in the My Health Record system may be limited to: image/jpeg, image/png, image/tiff, image/gif, application/pdf. | ||||
Control | 1..1 | ||||
Type | Attachment | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
60. Media.note | |||||
Definition | Comments made about the media by the performer, subject or other participants. | ||||
Short | Comments made about the media | ||||
Comments | Not to be used for observations, conclusions, etc. Instead use an Observation based on the Media/ImagingStudy resource. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |