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
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-media-core-1 | Version: 0.0.4 | |||
Draft as of 2024-09-12 | Computable Name: ADHAMediaCore | |||
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
The purpose of this profile is to provide a core representation of a media observation for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Media that are supported.
This profile is designed to set a core Media standard for:
This profile may be referred to by APIs, which will be listed here when available.
Media.identifier
as in the order or report connecting the resources that are related to a single request fulfilment workflow.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Media
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Media | 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 inv-dh-media-02: If present, an operator shall at least have a reference, an identifier or a display |
identifier | S | 0..* | Identifier | Identifier(s) for the image |
status | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Required Pattern: completed | |
type | S | 1..1 | CodeableConcept | Classification of media as image, video, or audio |
modality | S | 0..1 | CodeableConcept | The type of acquisition equipment/process |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Who/What this Media is a record of inv-dh-media-01: At least reference or a valid identifier shall be present |
created[x] | SC | 1..1 | dateTime, Period | When Media was collected inv-dh-media-03: Date shall be at least to day |
issued | S | 0..1 | instant | Date/Time this version was made available |
operator | SC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA System Device | ADHA Core RelatedPerson) | The person who generated the image |
content | S | 1..1 | Attachment | Actual Media - reference or data |
note | S | 0..* | Annotation | Comments made about the media |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-media-01 | error | Media.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-media-02 | error | Media | 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()) | |
inv-dh-media-03 | error | Media.created[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Media | 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 inv-dh-media-02: If present, an operator shall at least have a reference, an identifier or a display |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifier(s) for the image |
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. Required Pattern: completed |
type | SΣ | 1..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. |
modality | SΣ | 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. |
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who/What this Media is a record of inv-dh-media-01: At least reference or a valid identifier shall be present |
created[x] | SΣC | 1..1 | When Media was collected inv-dh-media-03: Date shall be at least to day | |
createdDateTime | dateTime | |||
createdPeriod | Period | |||
issued | SΣ | 0..1 | instant | Date/Time this version was made available |
operator | SΣC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA System Device | ADHA Core RelatedPerson) | The person who generated the image |
content | SΣ | 1..1 | Attachment | Actual Media - reference or data |
note | S | 0..* | Annotation | Comments made about the media |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Media.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | |
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-media-01 | error | Media.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-media-02 | error | Media | 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()) | |
inv-dh-media-03 | error | Media.created[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 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 inv-dh-media-02: If present, an operator shall at least have a reference, an identifier or a display | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Identifier(s) for the image | ||||
basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
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. Required Pattern: completed | ||||
type | SΣ | 1..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
modality | SΣ | 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 | SΣC | 1..1 | Reference(ADHA Core Patient) | Who/What this Media is a record of inv-dh-media-01: At least reference or a valid identifier shall be present | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
created[x] | SΣC | 1..1 | When Media was collected inv-dh-media-03: Date shall be at least to day | |||||
createdDateTime | dateTime | |||||||
createdPeriod | Period | |||||||
issued | SΣ | 0..1 | instant | Date/Time this version was made available | ||||
operator | SΣC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA System Device | ADHA Core RelatedPerson) | The person who generated the image | ||||
reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
deviceName | Σ | 0..1 | string | Name of the device/manufacturer | ||||
device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
height | Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
width | Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
frames | Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
duration | Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
content | SΣ | 1..1 | Attachment | Actual Media - reference or data | ||||
note | S | 0..* | Annotation | Comments made about the media | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Media.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Media.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | example | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-media-01 | error | Media.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-media-02 | error | Media | 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()) | |
inv-dh-media-03 | error | Media.created[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
This structure is derived from Media
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Media
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Media | 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 inv-dh-media-02: If present, an operator shall at least have a reference, an identifier or a display |
identifier | S | 0..* | Identifier | Identifier(s) for the image |
status | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Required Pattern: completed | |
type | S | 1..1 | CodeableConcept | Classification of media as image, video, or audio |
modality | S | 0..1 | CodeableConcept | The type of acquisition equipment/process |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Who/What this Media is a record of inv-dh-media-01: At least reference or a valid identifier shall be present |
created[x] | SC | 1..1 | dateTime, Period | When Media was collected inv-dh-media-03: Date shall be at least to day |
issued | S | 0..1 | instant | Date/Time this version was made available |
operator | SC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA System Device | ADHA Core RelatedPerson) | The person who generated the image |
content | S | 1..1 | Attachment | Actual Media - reference or data |
note | S | 0..* | Annotation | Comments made about the media |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-media-01 | error | Media.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-media-02 | error | Media | 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()) | |
inv-dh-media-03 | error | Media.created[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Media | 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 inv-dh-media-02: If present, an operator shall at least have a reference, an identifier or a display |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifier(s) for the image |
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. Required Pattern: completed |
type | SΣ | 1..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. |
modality | SΣ | 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. |
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who/What this Media is a record of inv-dh-media-01: At least reference or a valid identifier shall be present |
created[x] | SΣC | 1..1 | When Media was collected inv-dh-media-03: Date shall be at least to day | |
createdDateTime | dateTime | |||
createdPeriod | Period | |||
issued | SΣ | 0..1 | instant | Date/Time this version was made available |
operator | SΣC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA System Device | ADHA Core RelatedPerson) | The person who generated the image |
content | SΣ | 1..1 | Attachment | Actual Media - reference or data |
note | S | 0..* | Annotation | Comments made about the media |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Media.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | |
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-media-01 | error | Media.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-media-02 | error | Media | 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()) | |
inv-dh-media-03 | error | Media.created[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 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 inv-dh-media-02: If present, an operator shall at least have a reference, an identifier or a display | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Identifier(s) for the image | ||||
basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
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. Required Pattern: completed | ||||
type | SΣ | 1..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
modality | SΣ | 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 | SΣC | 1..1 | Reference(ADHA Core Patient) | Who/What this Media is a record of inv-dh-media-01: At least reference or a valid identifier shall be present | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
created[x] | SΣC | 1..1 | When Media was collected inv-dh-media-03: Date shall be at least to day | |||||
createdDateTime | dateTime | |||||||
createdPeriod | Period | |||||||
issued | SΣ | 0..1 | instant | Date/Time this version was made available | ||||
operator | SΣC | 0..1 | Reference(ADHA Core PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA System Device | ADHA Core RelatedPerson) | The person who generated the image | ||||
reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
deviceName | Σ | 0..1 | string | Name of the device/manufacturer | ||||
device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
height | Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
width | Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
frames | Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
duration | Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
content | SΣ | 1..1 | Attachment | Actual Media - reference or data | ||||
note | S | 0..* | Annotation | Comments made about the media | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Media.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Media.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | example | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-media-01 | error | Media.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-media-02 | error | Media | 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()) | |
inv-dh-media-03 | error | Media.created[x] | Date shall be at least to day : $this is DateTime implies $this.toString().length() >= 10 |
This structure is derived from Media
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.