AU Core Implementation Guide
0.1.0-draft - Draft
AU Core Implementation Guide
0.1.0-draft - Draft
This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-documentcomposition | Version: 0.1.0-draft | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreCompositionDocument | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a Composition resource to record, search, and fetch a clinical document for a patient. It is based on the AU Base Composition profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Composition when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | C | 0..* | AUBaseComposition | Composition for the Australian realm au-core-doc-01: Sections shall be unique by code |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 informationRecipient | S | 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 |
| type | S | 1..1 | CodeableConcept | Document sub type |
| category | S | 1..* | CodeableConcept | Categorization of Composition |
 subject | S | 1..1 | Reference(AU Core Patient) | Who and/or what the composition is about |
| encounter | S | 0..1 | Reference(AU Core Encounter) | Context of the Composition |
| date | SC | 1..1 | dateTime | Composition editing time au-core-doc-02: Date shall be at least to day |
| author | S | 1..* | Reference(AU Core PractitionerRole | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the composition |
| title | S | 1..1 | string | Human Readable name/title |
 attester | S | 0..* | BackboneElement | Attests to accuracy of composition |
 mode | S | 1..1 | code | personal | professional | legal | official |
| time | S | 1..1 | dateTime | When the composition was attested |
 party | S | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization) | Who attested the composition |
| custodian | S | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition |
| relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents |
| code | S | 1..1 | code | replaces | transforms | signs | appends |
| target[x] | S | 1..1 | Identifier, Reference(Composition) | Target of the relationship |
 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 |
| mode | 0..1 | code | working | snapshot | changes Fixed Value: snapshot | |
| entry | S | 0..* | Reference(Resource) | A reference to data that supports this section |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| emptyReason | S | 0..1 | CodeableConcept | Why the section is empty |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-doc-01 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| au-core-doc-02 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | C | 0..* | AUBaseComposition | Composition for the Australian realm au-core-doc-01: Sections shall be unique by code |
 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 | |
| informationRecipient | S | 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. |
| type | SΣ | 1..1 | CodeableConcept | Document sub type 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Σ | 1..1 | Reference(AU Core Patient) | Who and/or what the composition is about |
| encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Context of the Composition |
| date | SΣC | 1..1 | dateTime | Composition editing time au-core-doc-02: Date shall be at least to day |
| author | SΣ | 1..* | Reference(AU Core PractitionerRole | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the composition |
| title | SΣ | 1..1 | string | Human Readable name/title |
| attester | S | 0..* | BackboneElement | Attests to accuracy of composition |
| 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 | S | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization) | Who attested the composition |
| custodian | SΣ | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition |
| relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
 target[x] | S | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| section | SC | 1..* | BackboneElement | Composition is broken into sections |
| 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 |
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. Fixed Value: snapshot | |
| entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Composition.category | example | DocumentClassValueSet |
| Composition.attester.mode | required | CompositionAttestationMode |
| Composition.relatesTo.code | required | DocumentRelationshipType |
| Composition.section.code | example | DocumentSectionCodes |
| Composition.section.mode | required | Fixed Value: snapshot |
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-doc-01 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| au-core-doc-02 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | C | 0..* | AUBaseComposition | Composition for the Australian realm au-core-doc-01: Sections shall be unique by code | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| informationRecipient | S | 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. | ||||
| type | SΣ | 1..1 | CodeableConcept | Document sub type 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Σ | 1..1 | Reference(AU Core Patient) | Who and/or what the composition is about | ||||
| encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Context of the Composition | ||||
| date | SΣC | 1..1 | dateTime | Composition editing time au-core-doc-02: Date shall be at least to day | ||||
| author | SΣ | 1..* | Reference(AU Core PractitionerRole | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the composition | ||||
| title | SΣ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | S | 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 | 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 | S | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization) | Who attested the composition | ||||
| custodian | SΣ | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition | ||||
| relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
| target[x] | S | 1..1 | Target of the relationship | |||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(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 | ||||
| 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. Fixed Value: snapshot | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | preferred | FHIRDocumentTypeCodes | ||||
| Composition.category | example | DocumentClassValueSet | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | Fixed Value: snapshot | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.entry.type | extensible | ResourceType | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-doc-02 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
This structure is derived from AUBaseComposition
Summary
Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 24 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 0
Differential View
This structure is derived from AUBaseComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | C | 0..* | AUBaseComposition | Composition for the Australian realm au-core-doc-01: Sections shall be unique by code |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| informationRecipient | S | 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 |
| type | S | 1..1 | CodeableConcept | Document sub type |
| category | S | 1..* | CodeableConcept | Categorization of Composition |
| subject | S | 1..1 | Reference(AU Core Patient) | Who and/or what the composition is about |
| encounter | S | 0..1 | Reference(AU Core Encounter) | Context of the Composition |
| date | SC | 1..1 | dateTime | Composition editing time au-core-doc-02: Date shall be at least to day |
| author | S | 1..* | Reference(AU Core PractitionerRole | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the composition |
| title | S | 1..1 | string | Human Readable name/title |
| attester | S | 0..* | BackboneElement | Attests to accuracy of composition |
| mode | S | 1..1 | code | personal | professional | legal | official |
| time | S | 1..1 | dateTime | When the composition was attested |
| party | S | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization) | Who attested the composition |
| custodian | S | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition |
| relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents |
| code | S | 1..1 | code | replaces | transforms | signs | appends |
| target[x] | S | 1..1 | Identifier, Reference(Composition) | Target of the relationship |
| 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 |
| mode | 0..1 | code | working | snapshot | changes Fixed Value: snapshot | |
| entry | S | 0..* | Reference(Resource) | A reference to data that supports this section |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| emptyReason | S | 0..1 | CodeableConcept | Why the section is empty |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-doc-01 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| au-core-doc-02 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | C | 0..* | AUBaseComposition | Composition for the Australian realm au-core-doc-01: Sections shall be unique by code |
| 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 | |
| informationRecipient | S | 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. |
| type | SΣ | 1..1 | CodeableConcept | Document sub type 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Σ | 1..1 | Reference(AU Core Patient) | Who and/or what the composition is about |
| encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Context of the Composition |
| date | SΣC | 1..1 | dateTime | Composition editing time au-core-doc-02: Date shall be at least to day |
| author | SΣ | 1..* | Reference(AU Core PractitionerRole | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the composition |
| title | SΣ | 1..1 | string | Human Readable name/title |
| attester | S | 0..* | BackboneElement | Attests to accuracy of composition |
| 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 | S | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization) | Who attested the composition |
| custodian | SΣ | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition |
| relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
| target[x] | S | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| section | SC | 1..* | BackboneElement | Composition is broken into sections |
| 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 |
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. Fixed Value: snapshot | |
| entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Composition.category | example | DocumentClassValueSet |
| Composition.attester.mode | required | CompositionAttestationMode |
| Composition.relatesTo.code | required | DocumentRelationshipType |
| Composition.section.code | example | DocumentSectionCodes |
| Composition.section.mode | required | Fixed Value: snapshot |
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-doc-01 | error | Composition | Sections shall be unique by code : section.select(code.coding.code).isDistinct() | |
| au-core-doc-02 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | C | 0..* | AUBaseComposition | Composition for the Australian realm au-core-doc-01: Sections shall be unique by code | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| informationRecipient | S | 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. | ||||
| type | SΣ | 1..1 | CodeableConcept | Document sub type 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Σ | 1..1 | Reference(AU Core Patient) | Who and/or what the composition is about | ||||
| encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Context of the Composition | ||||
| date | SΣC | 1..1 | dateTime | Composition editing time au-core-doc-02: Date shall be at least to day | ||||
| author | SΣ | 1..* | Reference(AU Core PractitionerRole | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the composition | ||||
| title | SΣ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | S | 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 | 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 | S | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization) | Who attested the composition | ||||
| custodian | SΣ | 1..1 | Reference(AU Core Organization) | Organization which maintains the composition | ||||
| relatesTo | S | 0..* | BackboneElement | Relationships to other compositions/documents | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
| target[x] | S | 1..1 | Target of the relationship | |||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(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 | ||||
| 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. Fixed Value: snapshot | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | SC | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason | SC | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | preferred | FHIRDocumentTypeCodes | ||||
| Composition.category | example | DocumentClassValueSet | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | Fixed Value: snapshot | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.entry.type | extensible | ResourceType | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-doc-02 | error | Composition.date | Date shall be at least to day : toString().length() >= 10 |
This structure is derived from AUBaseComposition
Summary
Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 24 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 0
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.
| Name | Type | Conformance | Description | Path |
|---|---|---|---|---|
| TBD | TBD | TBD | TBD | TBD |
The following search parameters and search parameter combinations SHALL be supported:
The following search parameters and search parameter combinations SHOULD be supported:
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.1.0-draft based on FHIR 4.0.1. Generated 2023-03-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change