Australian Patient Summary Implementation Guide
0.0.1 - CI Build
Australian Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HealthIntersections/au-ips/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/ips/StructureDefinition/Media-observation-au-ips | Version: 0.0.1 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: MediaObservationAuIps |
This profile is based on the UV profile, with Australian rules added as well (by reference to the Australian profile)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MediaObservationUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Media | MediaObservationUvIps | |||
subject | 1..1 | Reference(Patient (AU IPS)) | Who/What this Media is a record of | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Media | 0..* | MediaObservationUvIps | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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. Fixed Value: completed |
subject | Σ | 1..1 | Reference(Patient (AU IPS)) | Who/What this Media is a record of |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
content | Σ | 1..1 | Attachment | Actual Media - reference or data |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Media.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id 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 | error | Media | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 0..* | MediaObservationUvIps | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | Σ | 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. Fixed Value: completed | ||||
type | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: MediaType (extensible): Codes for high level media categories. | |||||
modality | Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | ||||
view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
subject | Σ | 1..1 | Reference(Patient (AU IPS)) | Who/What this Media is a record of | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
created[x] | Σ | 0..1 | When Media was collected | |||||
createdDateTime | dateTime | |||||||
createdPeriod | Period | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
operator | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | ||||
reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): 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 | Σ | 1..1 | Attachment | Actual Media - reference or data | ||||
note | 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 | Fixed Value: 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.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types 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 |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id 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 | error | Media | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MediaObservationUvIps
Differential View
This structure is derived from MediaObservationUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Media | MediaObservationUvIps | |||
subject | 1..1 | Reference(Patient (AU IPS)) | Who/What this Media is a record of | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Media | 0..* | MediaObservationUvIps | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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. Fixed Value: completed |
subject | Σ | 1..1 | Reference(Patient (AU IPS)) | Who/What this Media is a record of |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
content | Σ | 1..1 | Attachment | Actual Media - reference or data |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Media.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id 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 | error | Media | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 0..* | MediaObservationUvIps | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | Σ | 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. Fixed Value: completed | ||||
type | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: MediaType (extensible): Codes for high level media categories. | |||||
modality | Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | ||||
view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
subject | Σ | 1..1 | Reference(Patient (AU IPS)) | Who/What this Media is a record of | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
created[x] | Σ | 0..1 | When Media was collected | |||||
createdDateTime | dateTime | |||||||
createdPeriod | Period | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
operator | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | ||||
reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): 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 | Σ | 1..1 | Attachment | Actual Media - reference or data | ||||
note | 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 | Fixed Value: 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.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types 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 |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id 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 | error | Media | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MediaObservationUvIps
Other representations of profile: CSV, Excel, Schematron