My Health Record FHIR IG
1.4.0 - active
My Health Record FHIR IG - Local Development build (v1.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-composition-phn-1 | Version: 1.4.0 | |||
| Computable Name: MHRCompositionPHN | ||||
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 define a representation of a Personal Health Notes 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.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Composition |
C | 0..* | AUBaseComposition | Personal Health Notes Constraints: inv-dh-doc-01, inv-dh-doc-02 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension: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 | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. 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: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |
| 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 |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
 category:phn |
Σ | 1..1 | CodeableConcept | Personal Health Notes Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. 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.16681 | |
| 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(MHR Patient) | Who and/or what the composition is about Constraints: inv-dh-doc-03 |
| encounter |
SΣ | 0..1 | Reference(MHR Encounter) | Context of the Composition |
| date |
SΣC | 1..1 | dateTime | Composition editing time Constraints: inv-dh-doc-07 |
| author |
SΣC | 1..1 | Reference(MHR Patient | MHR Authoring RelatedPerson | MHR Authoring Care Agency Employee) | Who and/or what authored the composition Constraints: inv-dh-doc-04 |
| title |
SΣ | 1..1 | string | Human Readable name/title |
| attester |
SC | 0..* | BackboneElement | Attests to accuracy of composition Constraints: inv-dh-doc-05 |
| 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 | 0..1 | Reference(MHR Authoring PractitionerRole | MHR Patient | MHR Authoring RelatedPerson) | Who attested the composition |
| custodian |
SΣC | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition Constraints: inv-dh-doc-06 |
| 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] |
1..1 | Target of the relationship | ||
| targetIdentifier |
Identifier | |||
| targetReference |
Reference(Composition) | |||
| section |
C | 0..1 | BackboneElement | Notes Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
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: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |
| 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | Pattern Value: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | |
| Composition.type | preferred | Pattern Value: LOINC Code 51855-5http://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | |
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | |
| Composition.category:phn | example | Pattern Value: 100.16681http://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | |
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1From the FHIR Standard | |
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | |
| Composition.section.code | example | Pattern Value: LOINC Code 51855-5http://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | 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() | |
| inv-dh-doc-01 | error | Composition | If present, an information recipient shall at least have a reference, an identifier or a display : extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').exists() implies extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').all(value.reference.exists() or value.identifier.exists() or value.display.exists()) | |
| inv-dh-doc-02 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| inv-dh-doc-03 | error | Composition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-04 | error | Composition.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-05 | error | Composition.attester | The party shall at least have a reference or a valid identifier : party.reference.exists() or party.identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-06 | error | Composition.custodian | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-07 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
This structure is derived from AUBaseComposition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
C | 0..* | AUBaseComposition | Personal Health Notes Constraints: inv-dh-doc-01, inv-dh-doc-02 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:informationRecipient |
SC | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient |
 identifier |
S | 1..1 | Identifier | Version-independent identifier for the Composition |
| status |
S | 1..1 | code | preliminary | final | amended | entered-in-error Required Pattern: final |
| type |
S | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) 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: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |
| Slices for category |
1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this | |
| category:phn |
1..1 | CodeableConcept | Personal Health Notes 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.16681 | |
| subject |
SC | 1..1 | Reference(MHR Patient) | Who and/or what the composition is about Constraints: inv-dh-doc-03 |
| encounter |
S | 0..1 | Reference(MHR Encounter) | Context of the Composition |
| date |
SC | 1..1 | dateTime | Composition editing time Constraints: inv-dh-doc-07 |
| author |
SC | 1..1 | Reference(MHR Patient | MHR Authoring RelatedPerson | MHR Authoring Care Agency Employee) | Who and/or what authored the composition Constraints: inv-dh-doc-04 |
| title |
S | 1..1 | string | Human Readable name/title |
| confidentiality |
0..0 | |||
| attester |
SC | 0..* | BackboneElement | Attests to accuracy of composition Constraints: inv-dh-doc-05 |
| mode |
S | 1..1 | code | personal | professional | legal | official |
| time |
S | 1..1 | dateTime | When the composition was attested |
| party |
SC | 0..1 | Reference(MHR Authoring PractitionerRole | MHR Patient | MHR Authoring RelatedPerson) | Who attested the composition |
| custodian |
SC | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition Constraints: inv-dh-doc-06 |
| relatesTo |
S | 0..* | BackboneElement | Relationships to other compositions/documents |
| code |
S | 1..1 | code | replaces | transforms | signs | appends |
| section |
0..1 | BackboneElement | Notes | |
| 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: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |
| entry |
0..0 | |||
| emptyReason |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-doc-01 | error | Composition | If present, an information recipient shall at least have a reference, an identifier or a display : extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').exists() implies extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').all(value.reference.exists() or value.identifier.exists() or value.display.exists()) | |
| inv-dh-doc-02 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| inv-dh-doc-03 | error | Composition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-04 | error | Composition.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-05 | error | Composition.attester | The party shall at least have a reference or a valid identifier : party.reference.exists() or party.identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-06 | error | Composition.custodian | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-07 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
C | 0..* | AUBaseComposition | Personal Health Notes Constraints: inv-dh-doc-01, inv-dh-doc-02 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension: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 | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. 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: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |||||
| 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 |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| category:phn |
Σ | 1..1 | CodeableConcept | Personal Health Notes Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. 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.16681 | |||||
| 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(MHR Patient) | Who and/or what the composition is about Constraints: inv-dh-doc-03 | ||||
| encounter |
SΣ | 0..1 | Reference(MHR Encounter) | Context of the Composition | ||||
| date |
SΣC | 1..1 | dateTime | Composition editing time Constraints: inv-dh-doc-07 | ||||
| author |
SΣC | 1..1 | Reference(MHR Patient | MHR Authoring RelatedPerson | MHR Authoring Care Agency Employee) | Who and/or what authored the composition Constraints: inv-dh-doc-04 | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
| attester |
SC | 0..* | BackboneElement | Attests to accuracy of composition Constraints: inv-dh-doc-05 | ||||
| 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 | 0..1 | Reference(MHR Authoring PractitionerRole | MHR Patient | MHR Authoring RelatedPerson) | Who attested the composition | ||||
| custodian |
SΣC | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition Constraints: inv-dh-doc-06 | ||||
| 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] |
1..1 | Target of the relationship | ||||||
| targetIdentifier |
Identifier | |||||||
| targetReference |
Reference(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 | ||||
| section |
C | 0..1 | BackboneElement | Notes Constraints: cmp-1, cmp-2 | ||||
| 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 |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
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: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |||||
| 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 |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Composition.status | required | Pattern Value: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | ||||
| Composition.type | preferred | Pattern Value: LOINC Code 51855-5http://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| Composition.category:phn | example | Pattern Value: 100.16681http://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | Pattern Value: LOINC Code 51855-5http://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1From the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | 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() | |
| inv-dh-doc-01 | error | Composition | If present, an information recipient shall at least have a reference, an identifier or a display : extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').exists() implies extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').all(value.reference.exists() or value.identifier.exists() or value.display.exists()) | |
| inv-dh-doc-02 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| inv-dh-doc-03 | error | Composition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-04 | error | Composition.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-05 | error | Composition.attester | The party shall at least have a reference or a valid identifier : party.reference.exists() or party.identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-06 | error | Composition.custodian | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-07 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
This structure is derived from AUBaseComposition
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
C | 0..* | AUBaseComposition | Personal Health Notes Constraints: inv-dh-doc-01, inv-dh-doc-02 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension: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 | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. 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: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |
| 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 |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
| category:phn |
Σ | 1..1 | CodeableConcept | Personal Health Notes Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. 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.16681 | |
| 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(MHR Patient) | Who and/or what the composition is about Constraints: inv-dh-doc-03 |
| encounter |
SΣ | 0..1 | Reference(MHR Encounter) | Context of the Composition |
| date |
SΣC | 1..1 | dateTime | Composition editing time Constraints: inv-dh-doc-07 |
| author |
SΣC | 1..1 | Reference(MHR Patient | MHR Authoring RelatedPerson | MHR Authoring Care Agency Employee) | Who and/or what authored the composition Constraints: inv-dh-doc-04 |
| title |
SΣ | 1..1 | string | Human Readable name/title |
| attester |
SC | 0..* | BackboneElement | Attests to accuracy of composition Constraints: inv-dh-doc-05 |
| 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 | 0..1 | Reference(MHR Authoring PractitionerRole | MHR Patient | MHR Authoring RelatedPerson) | Who attested the composition |
| custodian |
SΣC | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition Constraints: inv-dh-doc-06 |
| 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] |
1..1 | Target of the relationship | ||
| targetIdentifier |
Identifier | |||
| targetReference |
Reference(Composition) | |||
| section |
C | 0..1 | BackboneElement | Notes Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
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: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |
| 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | Pattern Value: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | |
| Composition.type | preferred | Pattern Value: LOINC Code 51855-5http://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | |
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | |
| Composition.category:phn | example | Pattern Value: 100.16681http://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | |
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1From the FHIR Standard | |
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | |
| Composition.section.code | example | Pattern Value: LOINC Code 51855-5http://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | 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() | |
| inv-dh-doc-01 | error | Composition | If present, an information recipient shall at least have a reference, an identifier or a display : extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').exists() implies extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').all(value.reference.exists() or value.identifier.exists() or value.display.exists()) | |
| inv-dh-doc-02 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| inv-dh-doc-03 | error | Composition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-04 | error | Composition.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-05 | error | Composition.attester | The party shall at least have a reference or a valid identifier : party.reference.exists() or party.identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-06 | error | Composition.custodian | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-07 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
Differential View
This structure is derived from AUBaseComposition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
C | 0..* | AUBaseComposition | Personal Health Notes Constraints: inv-dh-doc-01, inv-dh-doc-02 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:informationRecipient |
SC | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Information recipient URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient |
| identifier |
S | 1..1 | Identifier | Version-independent identifier for the Composition |
| status |
S | 1..1 | code | preliminary | final | amended | entered-in-error Required Pattern: final |
| type |
S | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) 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: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |
| Slices for category |
1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this | |
| category:phn |
1..1 | CodeableConcept | Personal Health Notes 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.16681 | |
| subject |
SC | 1..1 | Reference(MHR Patient) | Who and/or what the composition is about Constraints: inv-dh-doc-03 |
| encounter |
S | 0..1 | Reference(MHR Encounter) | Context of the Composition |
| date |
SC | 1..1 | dateTime | Composition editing time Constraints: inv-dh-doc-07 |
| author |
SC | 1..1 | Reference(MHR Patient | MHR Authoring RelatedPerson | MHR Authoring Care Agency Employee) | Who and/or what authored the composition Constraints: inv-dh-doc-04 |
| title |
S | 1..1 | string | Human Readable name/title |
| confidentiality |
0..0 | |||
| attester |
SC | 0..* | BackboneElement | Attests to accuracy of composition Constraints: inv-dh-doc-05 |
| mode |
S | 1..1 | code | personal | professional | legal | official |
| time |
S | 1..1 | dateTime | When the composition was attested |
| party |
SC | 0..1 | Reference(MHR Authoring PractitionerRole | MHR Patient | MHR Authoring RelatedPerson) | Who attested the composition |
| custodian |
SC | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition Constraints: inv-dh-doc-06 |
| relatesTo |
S | 0..* | BackboneElement | Relationships to other compositions/documents |
| code |
S | 1..1 | code | replaces | transforms | signs | appends |
| section |
0..1 | BackboneElement | Notes | |
| 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: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |
| entry |
0..0 | |||
| emptyReason |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-doc-01 | error | Composition | If present, an information recipient shall at least have a reference, an identifier or a display : extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').exists() implies extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').all(value.reference.exists() or value.identifier.exists() or value.display.exists()) | |
| inv-dh-doc-02 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| inv-dh-doc-03 | error | Composition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-04 | error | Composition.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-05 | error | Composition.attester | The party shall at least have a reference or a valid identifier : party.reference.exists() or party.identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-06 | error | Composition.custodian | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-07 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
C | 0..* | AUBaseComposition | Personal Health Notes Constraints: inv-dh-doc-01, inv-dh-doc-02 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension: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 | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. 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: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |||||
| 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 |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| category:phn |
Σ | 1..1 | CodeableConcept | Personal Health Notes Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. 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.16681 | |||||
| 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(MHR Patient) | Who and/or what the composition is about Constraints: inv-dh-doc-03 | ||||
| encounter |
SΣ | 0..1 | Reference(MHR Encounter) | Context of the Composition | ||||
| date |
SΣC | 1..1 | dateTime | Composition editing time Constraints: inv-dh-doc-07 | ||||
| author |
SΣC | 1..1 | Reference(MHR Patient | MHR Authoring RelatedPerson | MHR Authoring Care Agency Employee) | Who and/or what authored the composition Constraints: inv-dh-doc-04 | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
| attester |
SC | 0..* | BackboneElement | Attests to accuracy of composition Constraints: inv-dh-doc-05 | ||||
| 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 | 0..1 | Reference(MHR Authoring PractitionerRole | MHR Patient | MHR Authoring RelatedPerson) | Who attested the composition | ||||
| custodian |
SΣC | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition Constraints: inv-dh-doc-06 | ||||
| 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] |
1..1 | Target of the relationship | ||||||
| targetIdentifier |
Identifier | |||||||
| targetReference |
Reference(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 | ||||
| section |
C | 0..1 | BackboneElement | Notes Constraints: cmp-1, cmp-2 | ||||
| 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 |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
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: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 51855-5 | |||||
| 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 |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Composition.status | required | Pattern Value: finalhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | ||||
| Composition.type | preferred | Pattern Value: LOINC Code 51855-5http://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| Composition.category:phn | example | Pattern Value: 100.16681http://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | example | Pattern Value: LOINC Code 51855-5http://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1From the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | 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() | |
| inv-dh-doc-01 | error | Composition | If present, an information recipient shall at least have a reference, an identifier or a display : extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').exists() implies extension.where(url='http://hl7.org.au/fhir/StructureDefinition/information-recipient').all(value.reference.exists() or value.identifier.exists() or value.display.exists()) | |
| inv-dh-doc-02 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| inv-dh-doc-03 | error | Composition.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-04 | error | Composition.author | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-05 | error | Composition.attester | The party shall at least have a reference or a valid identifier : party.reference.exists() or party.identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-06 | error | Composition.custodian | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
| inv-dh-doc-07 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
This structure is derived from AUBaseComposition
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.4.0 based on FHIR 4.0.1. Generated 2025-07-24
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
