Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
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-core-1 | Version: 0.0.5 | |||
| Draft as of 2024-06-11 | Computable Name: ADHACompositionCore | |||
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
The purpose of this profile is to provide a core representation of a composition 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.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Composition that are supported.
Where a more specific Composition profile is applicable an implementation SHALL ensure the resource conforms to that specific profile.
This profile is designed to set a core Composition standard for:
None.
These profiles build on this profile (ADHA Core Composition) to define specific document compositions:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
  identifier |
S | 1..1 | Identifier | Version-independent identifier for the Composition |
| status |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
| type |
S | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) |
| category |
S | 1..* | CodeableConcept | Categorization of Composition |
 subject |
SC | 0..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-cmp-01: At least reference or a valid identifier shall be present |
| encounter |
S | 0..1 | Reference(ADHA Core Encounter) | Context of the Composition |
| date |
SC | 1..1 | dateTime | Composition editing time inv-dh-cmp-03: Date shall be at least to day |
| author |
SC | 1..* | Reference(ADHA Authoring PractitionerRole | ADHA System Device | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who and/or what authored the composition inv-dh-cmp-02: At least reference or a valid identifier shall be present |
| title |
S | 1..1 | string | Human Readable name/title |
| confidentiality |
0..0 | |||
 section |
S | 1..* | BackboneElement | Composition is broken into sections |
 title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 0..1 | CodeableConcept | Classification of section (recommended) |
| text |
S | 0..1 | Narrative | Text summary of the section, for human interpretation |
| entry |
S | 0..* | Reference(Resource) | A reference to data that supports this section |
 emptyReason |
S | 0..1 | CodeableConcept | Why the section is empty |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-cmp-01 | 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-cmp-02 | 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-cmp-03 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 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. |
| type |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| category |
SΣ | 1..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
| subject |
SΣC | 0..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-cmp-01: 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-cmp-03: Date shall be at least to day |
| author |
SΣC | 1..* | Reference(ADHA Authoring PractitionerRole | ADHA System Device | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who and/or what authored the composition inv-dh-cmp-02: At least reference or a valid identifier shall be present |
| title |
SΣ | 1..1 | string | Human Readable name/title |
| section |
SC | 1..* | BackboneElement | Composition is broken into sections 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 | 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 |
| emptyReason |
SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | |
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | |
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-cmp-01 | 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-cmp-02 | 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-cmp-03 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 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. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| category |
SΣ | 1..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject |
SΣC | 0..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-cmp-01: 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-cmp-03: Date shall be at least to day | ||||
| author |
SΣC | 1..* | Reference(ADHA Authoring PractitionerRole | ADHA System Device | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who and/or what authored the composition inv-dh-cmp-02: At least reference or a valid identifier shall be present | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
 attester |
0..* | BackboneElement | Attests to accuracy of composition | |||||
 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 |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time |
0..1 | dateTime | When the composition was attested | |||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| relatesTo |
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 |
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 |
SC | 1..* | BackboneElement | Composition is broken into sections 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 | 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. | |||||
| 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 | ||||
| emptyReason |
SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://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 | DocumentSectionCodeshttp://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 | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-cmp-01 | 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-cmp-02 | 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-cmp-03 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
This structure is derived from Composition
Summary
Mandatory: 3 elements
Must-Support: 15 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| identifier |
S | 1..1 | Identifier | Version-independent identifier for the Composition |
| status |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
| type |
S | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) |
| category |
S | 1..* | CodeableConcept | Categorization of Composition |
| subject |
SC | 0..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-cmp-01: At least reference or a valid identifier shall be present |
| encounter |
S | 0..1 | Reference(ADHA Core Encounter) | Context of the Composition |
| date |
SC | 1..1 | dateTime | Composition editing time inv-dh-cmp-03: Date shall be at least to day |
| author |
SC | 1..* | Reference(ADHA Authoring PractitionerRole | ADHA System Device | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who and/or what authored the composition inv-dh-cmp-02: At least reference or a valid identifier shall be present |
| title |
S | 1..1 | string | Human Readable name/title |
| confidentiality |
0..0 | |||
| section |
S | 1..* | BackboneElement | Composition is broken into sections |
| title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 0..1 | CodeableConcept | Classification of section (recommended) |
| text |
S | 0..1 | Narrative | Text summary of the section, for human interpretation |
| entry |
S | 0..* | Reference(Resource) | A reference to data that supports this section |
| emptyReason |
S | 0..1 | CodeableConcept | Why the section is empty |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-cmp-01 | 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-cmp-02 | 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-cmp-03 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| 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. |
| type |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
| category |
SΣ | 1..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
| subject |
SΣC | 0..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-cmp-01: 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-cmp-03: Date shall be at least to day |
| author |
SΣC | 1..* | Reference(ADHA Authoring PractitionerRole | ADHA System Device | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who and/or what authored the composition inv-dh-cmp-02: At least reference or a valid identifier shall be present |
| title |
SΣ | 1..1 | string | Human Readable name/title |
| section |
SC | 1..* | BackboneElement | Composition is broken into sections 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 | 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 |
| emptyReason |
SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | |
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | |
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-cmp-01 | 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-cmp-02 | 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-cmp-03 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 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. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| category |
SΣ | 1..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject |
SΣC | 0..1 | Reference(ADHA Core Patient) | Who and/or what the composition is about inv-dh-cmp-01: 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-cmp-03: Date shall be at least to day | ||||
| author |
SΣC | 1..* | Reference(ADHA Authoring PractitionerRole | ADHA System Device | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA Core Organization) | Who and/or what authored the composition inv-dh-cmp-02: At least reference or a valid identifier shall be present | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
| attester |
0..* | BackboneElement | Attests to accuracy of composition | |||||
| 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 |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time |
0..1 | dateTime | When the composition was attested | |||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| relatesTo |
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 |
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 |
SC | 1..* | BackboneElement | Composition is broken into sections 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 | 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. | |||||
| 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 | ||||
| emptyReason |
SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://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 | DocumentSectionCodeshttp://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 | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-cmp-01 | 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-cmp-02 | 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-cmp-03 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
This structure is derived from Composition
Summary
Mandatory: 3 elements
Must-Support: 15 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-06-11
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
