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-composition-phs-0 | Version: 0.0.2 | |||
Draft as of 2024-09-12 | Computable Name: ADHACompositionPHS | |||
Copyright/Legal: Copyright © 2023 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 define a representation of a Personal Health Summary document for a patient for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. A composition is a set of resources composed into a single coherent clinical statement that may have clinical attestation.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ADHACompositionDocument
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | ADHACompositionDocument | Personal Health Summary | |
status | 1..1 | code | preliminary | final | amended | entered-in-error Required Pattern: final | |
type | 1..1 | CodeableConcept | Document sub type Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |
Slices for category | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this | |
category:phs | 1..1 | CodeableConcept | Personal Health Summary Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |
author | 1..1 | Reference(ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Authoring Care Agency Employee) | Who and/or what authored the composition | |
Slices for section | C | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by pattern:code inv-dh-phs-01: A section shall at least have an entry or an empty reason inv-dh-phs-02: All observations shall conform to ADHA Simple Observation |
section:All Slices | Content/Rules for all slices | |||
title | 1..1 | string | Label for section (e.g. for ToC) | |
section | 0..0 | |||
section:allergies | 1..1 | BackboneElement | Allergies | |
code | 1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.20113 | |
entry | C | 0..* | Reference(ADHA Core AllergyIntolerance) | Allergies and/or intolerances |
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) |
section:currentmedicicines | C | 1..1 | BackboneElement | Current Medicines inv-dh-phs-04: If an assertion of no known current medications is provided, no other entry shall be present |
code | 1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.32009 | |
entry | C | 0..* | Reference(ADHA Core MedicationStatement | http://hl7.org.au/fhir/core/StructureDefinition/au-core-norelevantfinding) | Medicines the patient is currently taking |
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Composition.section:allergies.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 | |
Composition.section:currentmedicicines.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | C | 0..* | ADHACompositionDocument | Personal Health Summary inv-dh-doc-01: If present, an information recipient shall at least have a reference, an identifier or a display inv-dh-doc-02: Sections shall be unique by code |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
informationRecipient | SC | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..1 | Identifier | Version-independent identifier for the Composition |
status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final |
type | SΣ | 1..1 | CodeableConcept | Document sub type Binding: My Health Record Record Type (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |
Slices for category | SΣ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this Binding: My Health Record Record Class (extensible) |
category:phs | SΣ | 1..1 | CodeableConcept | Personal Health Summary Binding: My Health Record Record Class (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-doc-03: At least reference or a valid identifier shall be present |
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Context of the Composition |
date | SΣC | 1..1 | dateTime | Composition editing time inv-dh-doc-07: Date shall be at least to day |
author | SΣC | 1..1 | Reference(ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Authoring Care Agency Employee) | Who and/or what authored the composition inv-dh-doc-04: At least reference or a valid identifier shall be present |
title | SΣ | 1..1 | string | Human Readable name/title |
attester | SC | 0..* | BackboneElement | Attests to accuracy of composition inv-dh-doc-05: The party shall at least have a reference or a valid identifier |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | S | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. |
time | S | 1..1 | dateTime | When the composition was attested |
party | SC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who attested the composition |
custodian | SΣC | 1..1 | Reference(ADHA Core Organization) | Organization which maintains the composition inv-dh-doc-06: At least reference or a valid identifier shall be present |
relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
target[x] | S | 1..1 | Target of the relationship | |
targetIdentifier | Identifier | |||
targetReference | Reference(ADHA Core Composition) | |||
Slices for section | SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by pattern:code cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty inv-dh-phs-01: A section shall at least have an entry or an empty reason inv-dh-phs-02: All observations shall conform to ADHA Simple Observation |
section:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
title | S | 1..1 | string | Label for section (e.g. for ToC) |
code | S | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. |
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. |
section:allergies | SC | 1..1 | BackboneElement | Allergies cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
title | S | 0..1 | string | Label for section (e.g. for ToC) |
code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.20113 | |
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
entry | SC | 0..* | Reference(ADHA Core AllergyIntolerance) | Allergies and/or intolerances |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) |
section:currentmedicicines | SC | 1..1 | BackboneElement | Current Medicines cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty inv-dh-phs-04: If an assertion of no known current medications is provided, no other entry shall be present |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
title | S | 0..1 | string | Label for section (e.g. for ToC) |
code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.32009 | |
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
entry | SC | 0..* | Reference(ADHA Core MedicationStatement | http://hl7.org.au/fhir/core/StructureDefinition/au-core-norelevantfinding) | Medicines the patient is currently taking |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | |
Composition.type | extensible | Pattern: 100.16685https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-type-1 | |
Composition.category | extensible | MyHealthRecordRecordClass https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-class-1 | |
Composition.category:phs | extensible | Pattern: 100.16685https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-class-1 | |
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | |
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | |
Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | |
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | |
Composition.section:allergies.code | example | Pattern: 101.20113http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | |
Composition.section:allergies.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 | |
Composition.section:currentmedicicines.code | example | Pattern: 101.32009http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | |
Composition.section:currentmedicicines.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | C | 0..* | ADHACompositionDocument | Personal Health Summary inv-dh-doc-01: If present, an information recipient shall at least have a reference, an identifier or a display inv-dh-doc-02: Sections shall be unique by code | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
informationRecipient | SC | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..1 | Identifier | Version-independent identifier for the Composition | ||||
status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final | ||||
type | SΣ | 1..1 | CodeableConcept | Document sub type Binding: My Health Record Record Type (extensible) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
Slices for category | SΣ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this Binding: My Health Record Record Class (extensible) | ||||
category:phs | SΣ | 1..1 | CodeableConcept | Personal Health Summary Binding: My Health Record Record Class (extensible) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-doc-03: At least reference or a valid identifier shall be present | ||||
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Context of the Composition | ||||
date | SΣC | 1..1 | dateTime | Composition editing time inv-dh-doc-07: Date shall be at least to day | ||||
author | SΣC | 1..1 | Reference(ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Authoring Care Agency Employee) | Who and/or what authored the composition inv-dh-doc-04: At least reference or a valid identifier shall be present | ||||
title | SΣ | 1..1 | string | Human Readable name/title | ||||
attester | SC | 0..* | BackboneElement | Attests to accuracy of composition inv-dh-doc-05: The party shall at least have a reference or a valid identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | S | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | ||||
time | S | 1..1 | dateTime | When the composition was attested | ||||
party | SC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who attested the composition | ||||
custodian | SΣC | 1..1 | Reference(ADHA Core Organization) | Organization which maintains the composition inv-dh-doc-06: At least reference or a valid identifier shall be present | ||||
relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
target[x] | S | 1..1 | Target of the relationship | |||||
targetIdentifier | Identifier | |||||||
targetReference | Reference(ADHA Core Composition) | |||||||
event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
period | Σ | 0..1 | Period | The period covered by the documentation | ||||
detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
Slices for section | SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by pattern:code cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty inv-dh-phs-01: A section shall at least have an entry or an empty reason inv-dh-phs-02: All observations shall conform to ADHA Simple Observation | ||||
section:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | S | 1..1 | string | Label for section (e.g. for ToC) | ||||
code | S | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | ||||
author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. Fixed Value: snapshot | |||||
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
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 | ||||
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
section:allergies | SC | 1..1 | BackboneElement | Allergies cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | S | 0..1 | string | Label for section (e.g. for ToC) | ||||
code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.20113 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. Fixed Value: snapshot | |||||
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
entry | SC | 0..* | Reference(ADHA Core AllergyIntolerance) | Allergies and/or intolerances | ||||
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 | ||||
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) | ||||
section | C | 0..* | See section (Composition) | Nested Section | ||||
section:currentmedicicines | SC | 1..1 | BackboneElement | Current Medicines cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty inv-dh-phs-04: If an assertion of no known current medications is provided, no other entry shall be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | S | 0..1 | string | Label for section (e.g. for ToC) | ||||
code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.32009 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. Fixed Value: snapshot | |||||
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
entry | SC | 0..* | Reference(ADHA Core MedicationStatement | http://hl7.org.au/fhir/core/StructureDefinition/au-core-norelevantfinding) | Medicines the patient is currently taking | ||||
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 | ||||
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) | ||||
section | C | 0..* | See section (Composition) | Nested Section | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | Pattern: 100.16685https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-type-1 | ||||
Composition.category | extensible | MyHealthRecordRecordClass https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-class-1 | ||||
Composition.category:phs | extensible | Pattern: 100.16685https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-class-1 | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section.mode | required | Fixed Value: snapshothttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.entry.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | ||||
Composition.section:allergies.code | example | Pattern: 101.20113http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:allergies.mode | required | Fixed Value: snapshothttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:allergies.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:allergies.entry.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.section:allergies.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 | ||||
Composition.section:currentmedicicines.code | example | Pattern: 101.32009http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:currentmedicicines.mode | required | Fixed Value: snapshothttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:currentmedicicines.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:currentmedicicines.entry.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.section:currentmedicicines.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 |
This structure is derived from ADHACompositionDocument
Summary
Mandatory: 7 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ADHACompositionDocument
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | ADHACompositionDocument | Personal Health Summary | |
status | 1..1 | code | preliminary | final | amended | entered-in-error Required Pattern: final | |
type | 1..1 | CodeableConcept | Document sub type Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |
Slices for category | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this | |
category:phs | 1..1 | CodeableConcept | Personal Health Summary Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |
author | 1..1 | Reference(ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Authoring Care Agency Employee) | Who and/or what authored the composition | |
Slices for section | C | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by pattern:code inv-dh-phs-01: A section shall at least have an entry or an empty reason inv-dh-phs-02: All observations shall conform to ADHA Simple Observation |
section:All Slices | Content/Rules for all slices | |||
title | 1..1 | string | Label for section (e.g. for ToC) | |
section | 0..0 | |||
section:allergies | 1..1 | BackboneElement | Allergies | |
code | 1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.20113 | |
entry | C | 0..* | Reference(ADHA Core AllergyIntolerance) | Allergies and/or intolerances |
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) |
section:currentmedicicines | C | 1..1 | BackboneElement | Current Medicines inv-dh-phs-04: If an assertion of no known current medications is provided, no other entry shall be present |
code | 1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.32009 | |
entry | C | 0..* | Reference(ADHA Core MedicationStatement | http://hl7.org.au/fhir/core/StructureDefinition/au-core-norelevantfinding) | Medicines the patient is currently taking |
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Composition.section:allergies.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 | |
Composition.section:currentmedicicines.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | C | 0..* | ADHACompositionDocument | Personal Health Summary inv-dh-doc-01: If present, an information recipient shall at least have a reference, an identifier or a display inv-dh-doc-02: Sections shall be unique by code |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
informationRecipient | SC | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..1 | Identifier | Version-independent identifier for the Composition |
status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final |
type | SΣ | 1..1 | CodeableConcept | Document sub type Binding: My Health Record Record Type (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |
Slices for category | SΣ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this Binding: My Health Record Record Class (extensible) |
category:phs | SΣ | 1..1 | CodeableConcept | Personal Health Summary Binding: My Health Record Record Class (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-doc-03: At least reference or a valid identifier shall be present |
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Context of the Composition |
date | SΣC | 1..1 | dateTime | Composition editing time inv-dh-doc-07: Date shall be at least to day |
author | SΣC | 1..1 | Reference(ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Authoring Care Agency Employee) | Who and/or what authored the composition inv-dh-doc-04: At least reference or a valid identifier shall be present |
title | SΣ | 1..1 | string | Human Readable name/title |
attester | SC | 0..* | BackboneElement | Attests to accuracy of composition inv-dh-doc-05: The party shall at least have a reference or a valid identifier |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | S | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. |
time | S | 1..1 | dateTime | When the composition was attested |
party | SC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who attested the composition |
custodian | SΣC | 1..1 | Reference(ADHA Core Organization) | Organization which maintains the composition inv-dh-doc-06: At least reference or a valid identifier shall be present |
relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
target[x] | S | 1..1 | Target of the relationship | |
targetIdentifier | Identifier | |||
targetReference | Reference(ADHA Core Composition) | |||
Slices for section | SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by pattern:code cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty inv-dh-phs-01: A section shall at least have an entry or an empty reason inv-dh-phs-02: All observations shall conform to ADHA Simple Observation |
section:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
title | S | 1..1 | string | Label for section (e.g. for ToC) |
code | S | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. |
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. |
section:allergies | SC | 1..1 | BackboneElement | Allergies cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
title | S | 0..1 | string | Label for section (e.g. for ToC) |
code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.20113 | |
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
entry | SC | 0..* | Reference(ADHA Core AllergyIntolerance) | Allergies and/or intolerances |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) |
section:currentmedicicines | SC | 1..1 | BackboneElement | Current Medicines cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty inv-dh-phs-04: If an assertion of no known current medications is provided, no other entry shall be present |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
title | S | 0..1 | string | Label for section (e.g. for ToC) |
code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.32009 | |
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
entry | SC | 0..* | Reference(ADHA Core MedicationStatement | http://hl7.org.au/fhir/core/StructureDefinition/au-core-norelevantfinding) | Medicines the patient is currently taking |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | |
Composition.type | extensible | Pattern: 100.16685https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-type-1 | |
Composition.category | extensible | MyHealthRecordRecordClass https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-class-1 | |
Composition.category:phs | extensible | Pattern: 100.16685https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-class-1 | |
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | |
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | |
Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | |
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | |
Composition.section:allergies.code | example | Pattern: 101.20113http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | |
Composition.section:allergies.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 | |
Composition.section:currentmedicicines.code | example | Pattern: 101.32009http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | |
Composition.section:currentmedicicines.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | C | 0..* | ADHACompositionDocument | Personal Health Summary inv-dh-doc-01: If present, an information recipient shall at least have a reference, an identifier or a display inv-dh-doc-02: Sections shall be unique by code | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
informationRecipient | SC | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..1 | Identifier | Version-independent identifier for the Composition | ||||
status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. Required Pattern: final | ||||
type | SΣ | 1..1 | CodeableConcept | Document sub type Binding: My Health Record Record Type (extensible) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
Slices for category | SΣ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this Binding: My Health Record Record Class (extensible) | ||||
category:phs | SΣ | 1..1 | CodeableConcept | Personal Health Summary Binding: My Health Record Record Class (extensible) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 100.16685 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-doc-03: At least reference or a valid identifier shall be present | ||||
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Context of the Composition | ||||
date | SΣC | 1..1 | dateTime | Composition editing time inv-dh-doc-07: Date shall be at least to day | ||||
author | SΣC | 1..1 | Reference(ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Authoring Care Agency Employee) | Who and/or what authored the composition inv-dh-doc-04: At least reference or a valid identifier shall be present | ||||
title | SΣ | 1..1 | string | Human Readable name/title | ||||
attester | SC | 0..* | BackboneElement | Attests to accuracy of composition inv-dh-doc-05: The party shall at least have a reference or a valid identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | S | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | ||||
time | S | 1..1 | dateTime | When the composition was attested | ||||
party | SC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who attested the composition | ||||
custodian | SΣC | 1..1 | Reference(ADHA Core Organization) | Organization which maintains the composition inv-dh-doc-06: At least reference or a valid identifier shall be present | ||||
relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
target[x] | S | 1..1 | Target of the relationship | |||||
targetIdentifier | Identifier | |||||||
targetReference | Reference(ADHA Core Composition) | |||||||
event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
period | Σ | 0..1 | Period | The period covered by the documentation | ||||
detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
Slices for section | SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Closed by pattern:code cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty inv-dh-phs-01: A section shall at least have an entry or an empty reason inv-dh-phs-02: All observations shall conform to ADHA Simple Observation | ||||
section:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | S | 1..1 | string | Label for section (e.g. for ToC) | ||||
code | S | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | ||||
author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. Fixed Value: snapshot | |||||
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
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 | ||||
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
section:allergies | SC | 1..1 | BackboneElement | Allergies cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | S | 0..1 | string | Label for section (e.g. for ToC) | ||||
code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.20113 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. Fixed Value: snapshot | |||||
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
entry | SC | 0..* | Reference(ADHA Core AllergyIntolerance) | Allergies and/or intolerances | ||||
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 | ||||
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) | ||||
section | C | 0..* | See section (Composition) | Nested Section | ||||
section:currentmedicicines | SC | 1..1 | BackboneElement | Current Medicines cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty inv-dh-phs-04: If an assertion of no known current medications is provided, no other entry shall be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | S | 0..1 | string | Label for section (e.g. for ToC) | ||||
code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://healthterminologies.gov.au/fhir/CodeSystem/nctis-data-components-1 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 101.32009 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. Fixed Value: snapshot | |||||
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
entry | SC | 0..* | Reference(ADHA Core MedicationStatement | http://hl7.org.au/fhir/core/StructureDefinition/au-core-norelevantfinding) | Medicines the patient is currently taking | ||||
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 | ||||
emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: Health Summary Non-Clinical Empty Reason (required) | ||||
section | C | 0..* | See section (Composition) | Nested Section | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | extensible | Pattern: 100.16685https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-type-1 | ||||
Composition.category | extensible | MyHealthRecordRecordClass https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-class-1 | ||||
Composition.category:phs | extensible | Pattern: 100.16685https://healthterminologies.gov.au/fhir/ValueSet/mhr-record-class-1 | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section.mode | required | Fixed Value: snapshothttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.entry.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard | ||||
Composition.section:allergies.code | example | Pattern: 101.20113http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:allergies.mode | required | Fixed Value: snapshothttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:allergies.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:allergies.entry.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.section:allergies.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 | ||||
Composition.section:currentmedicicines.code | example | Pattern: 101.32009http://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section:currentmedicicines.mode | required | Fixed Value: snapshothttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section:currentmedicicines.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section:currentmedicicines.entry.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Composition.section:currentmedicicines.emptyReason | required | HealthSummaryNonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/health-summary-non-clinical-empty-reason-2 |
This structure is derived from ADHACompositionDocument
Summary
Mandatory: 7 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron