AU Patient Summary Implementation Guide
0.1.0-preview - Preview Australia flag

This page is part of the AU Patient Summary (v0.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: AU PS Composition

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-composition Version: 0.1.0-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUPSComposition

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Composition resource in the context of a patient summary in an Australian context. It is based on AU Base Composition and imposes Composition (IPS).

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Profile specific implementation guidance

  • See Composition (IPS) for the additional requirements imposed by IPS on the Composition resource e.g. for the mandatory sections (meds, allergies, etc.) constraint ips-comp-1: Either section.entry or emptyReason are present is imposed.
  • See guidance on how to represent Empty & Known Absent Sections in IPS.
  • See Narrative Content Guidance in IPS.
  • See guidance on reprenting medications information in the Medications Summary section on the Medication Lists in the IPS section in IPS.
  • The patient summary document may be constructed by a human or an automated process, regardless of whether the patient summary contains some content of both kinds. In all instances, document level authorship information is required. As per the guidance in IPS:
    • The distinction between the two types of IPS, human-curated or software-assembled, is based on the authors recorded in the composition: the author shall be a human (e.g. Practitioner), if the IPS provenance type is “human-curated”, or a device if the IPS provenance type is “software-assembled”. In the case of a software-assembled IPS that is then verified by a human, the document provenance type shall be “software-assembled” and the author shall be the device or system that constructed the IPS document, but an additional attester identity shall name the human who performed this check.
    • Additional provenance information below the document level is optional. There are no Provenance profiles currently defined by this guide, or by IPS or AU Core.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AUBaseComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* AUBaseComposition Patient Summary composition
This profile also imposes the profile Composition (IPS)
... text S 0..1 Narrative Text summary of the resource, for human interpretation
... identifier S 0..1 Identifier Version-independent identifier for the Composition
... status S 1..1 code preliminary | final | amended | entered-in-error
.... 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: 60591-5
... subject S 1..1 Reference(AU PS Patient) Who and/or what the composition is about
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... date S 1..1 dateTime Composition editing time
... author S 1..* Reference(AU PS Practitioner | AU PS PractitionerRole | Device | AU PS Patient | AU PS RelatedPerson | AU PS Organization) Who and/or what authored the patient summary
... title S 1..1 string Patient Summary
... attester S 0..* BackboneElement Attests to accuracy of composition
.... mode S 1..1 code personal | professional | legal | official
.... time S 0..1 dateTime When the composition was attested
.... party S 0..1 Reference(AU PS Patient | AU PS RelatedPerson | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) Who attested the composition
... custodian S 0..1 Reference(AU PS Organization) Organization which maintains the composition
... relatesTo
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition | Composition (IPS) | AU PS Composition)
... Slices for event 0..* BackboneElement The clinical service(s) being documented
Slice: Unordered, Open by pattern:code
.... event:careProvisioningEvent S 0..1 BackboneElement The care provisioning being documented
..... code S 1..1 CodeableConcept Code(s) that apply to the event being documented
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://terminology.hl7.org/CodeSystem/v3-ActClass
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PCPR
..... period S 0..1 Period The period covered by the documentation
... Slices for section S 3..* BackboneElement Sections composing the patient summary
Slice: Unordered, Open by pattern:code
.... section:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... text S 1..1 Narrative Text summary of the section, for human interpretation
..... section 0..0
.... section:sectionProblems S 1..1 BackboneElement IPS Problems Section
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 11450-4
..... Slices for entry S 0..* Reference(Condition | DocumentReference) Clinical problems or conditions currently being monitored for the patient.
Slice: Unordered, Open by profile:resolve()
...... entry:problem S 0..* Reference(AU PS Condition) A reference to data that supports this section
.... section:sectionAllergies S 1..1 BackboneElement IPS Allergies and Intolerances Section
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 48765-2
..... Slices for entry S 0..* Reference(AllergyIntolerance | DocumentReference) Relevant allergies or intolerances (conditions) for that patient.
Slice: Unordered, Open by profile:resolve()
...... entry:allergyOrIntolerance S 0..* Reference(AU PS AllergyIntolerance) A reference to data that supports this section
.... section:sectionMedications S 1..1 BackboneElement IPS Medication Summary Section
..... title S 1..1 string Medication Summary section
..... code 1..1 CodeableConceptIPS 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: 10160-0
..... Slices for entry S 0..* Reference(MedicationStatement | MedicationRequest | MedicationAdministration | MedicationDispense | DocumentReference) Medications relevant for the scope of the patient summary
Slice: Unordered, Open by profile:resolve()
...... entry:medicationStatement S 0..* Reference(AU PS MedicationStatement) A reference to data that supports this section
...... entry:medicationRequest S 0..* Reference(AU PS MedicationRequest) A reference to data that supports this section
.... section:sectionImmunizations S 0..1 BackboneElement Immunizations Section
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 11369-6
..... Slices for entry S 0..* Reference(Immunization | DocumentReference) Patient's immunization status and pertinent history.
Slice: Unordered, Open by profile:resolve()
...... entry:immunization S 0..* Reference(AU PS Immunization) A reference to data that supports this section

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* AUBaseComposition Patient Summary composition
This profile also imposes the profile Composition (IPS)
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... text S 0..1 Narrative Text summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:informationRecipient 0..* Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) Who and/or what should receive a copy of the composition
URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..1 Identifier Version-independent identifier for the Composition
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 CodeableConceptIPS Kind of composition ("Patient Summary")
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


ele-1: All FHIR elements must have a @value or children
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: 60591-5
... subject SΣ 1..1 Reference(AU PS Patient) Who and/or what the composition is about
ele-1: All FHIR elements must have a @value or children
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Composition editing time
ele-1: All FHIR elements must have a @value or children
... author SΣ 1..* Reference(AU PS Practitioner | AU PS PractitionerRole | Device | AU PS Patient | AU PS RelatedPerson | AU PS Organization) Who and/or what authored the patient summary
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Patient Summary
ele-1: All FHIR elements must have a @value or children
... attester S 0..* BackboneElement Attests to accuracy of composition
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... mode S 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


ele-1: All FHIR elements must have a @value or children
.... time S 0..1 dateTime When the composition was attested
ele-1: All FHIR elements must have a @value or children
.... party S 0..1 Reference(AU PS Patient | AU PS RelatedPerson | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) Who attested the composition
ele-1: All FHIR elements must have a @value or children
... custodian SΣ 0..1 Reference(AU PS Organization) Organization which maintains the composition
ele-1: All FHIR elements must have a @value or children
... Slices for event Σ 0..* BackboneElement The clinical service(s) being documented
Slice: Unordered, Open by pattern:code
ele-1: All FHIR elements must have a @value or children
.... event:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... event:careProvisioningEvent SΣ 0..1 BackboneElement The care provisioning being documented
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code SΣ 1..1 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.


ele-1: All FHIR elements must have a @value or children

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://terminology.hl7.org/CodeSystem/v3-ActClass
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PCPR
..... period SΣ 0..1 Period The period covered by the documentation
ele-1: All FHIR elements must have a @value or children
... Slices for section SC 3..* BackboneElement Sections composing the patient summary
Slice: Unordered, Open by pattern:code
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
ele-1: All FHIR elements must have a @value or children
.... section:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
.... section:sectionProblems SC 1..1 BackboneElement IPS Problems Section
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
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title S 1..1 string Label for section (e.g. for ToC)
ele-1: All FHIR elements must have a @value or children
..... code 1..1 CodeableConceptIPS Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


ele-1: All FHIR elements must have a @value or children
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: 11450-4
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
..... Slices for entry SC 0..* Reference(Condition | DocumentReference) Clinical problems or conditions currently being monitored for the patient.
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
...... entry:problem SC 0..* Reference(AU PS Condition) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
.... section:sectionAllergies SC 1..1 BackboneElement IPS Allergies and Intolerances Section
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
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title S 1..1 string Label for section (e.g. for ToC)
ele-1: All FHIR elements must have a @value or children
..... code 1..1 CodeableConceptIPS Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


ele-1: All FHIR elements must have a @value or children
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: 48765-2
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
..... Slices for entry SC 0..* Reference(AllergyIntolerance | DocumentReference) Relevant allergies or intolerances (conditions) for that patient.
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
...... entry:allergyOrIntolerance SC 0..* Reference(AU PS AllergyIntolerance) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
.... section:sectionMedications SC 1..1 BackboneElement IPS Medication Summary Section
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
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title S 1..1 string Medication Summary section
ele-1: All FHIR elements must have a @value or children
..... code 1..1 CodeableConceptIPS Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


ele-1: All FHIR elements must have a @value or children
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: 10160-0
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
..... Slices for entry SC 0..* Reference(MedicationStatement | MedicationRequest | MedicationAdministration | MedicationDispense | DocumentReference) Medications relevant for the scope of the patient summary
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
...... entry:medicationStatement SC 0..* Reference(AU PS MedicationStatement) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
...... entry:medicationRequest SC 0..* Reference(AU PS MedicationRequest) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
.... section:sectionImmunizations SC 0..1 BackboneElement Immunizations Section
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
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title S 1..1 string Label for section (e.g. for ToC)
ele-1: All FHIR elements must have a @value or children
..... code 1..1 CodeableConceptIPS Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


ele-1: All FHIR elements must have a @value or children
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: 11369-6
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
..... Slices for entry SC 0..* Reference(Immunization | DocumentReference) Patient's immunization status and pertinent history.
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
...... entry:immunization SC 0..* Reference(AU PS Immunization) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredPattern: LOINC Code 60591-5
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.event:careProvisioningEvent.codeexamplePattern: PCPR
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section:sectionProblems.codeexamplePattern: LOINC Code 11450-4
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionAllergies.codeexamplePattern: LOINC Code 48765-2
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionMedications.codeexamplePattern: LOINC Code 10160-0
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionImmunizations.codeexamplePattern: LOINC Code 11369-6
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:sectionProblems, Composition.section:sectionAllergies, Composition.section:sectionMedications, Composition.section:sectionImmunizationsA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:sectionProblems, Composition.section:sectionAllergies, Composition.section:sectionMedications, Composition.section:sectionImmunizationsA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* AUBaseComposition Patient Summary composition
This profile also imposes the profile Composition (IPS)
... 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
... text S 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
.... extension:informationRecipient 0..* Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) Who and/or what should receive a copy of the composition
URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..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 CodeableConceptIPS Kind of composition ("Patient Summary")
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: 60591-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
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ 1..1 Reference(AU PS Patient) Who and/or what the composition is about
.... 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 SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date SΣ 1..1 dateTime Composition editing time
... author SΣ 1..* Reference(AU PS Practitioner | AU PS PractitionerRole | Device | AU PS Patient | AU PS RelatedPerson | AU PS Organization) Who and/or what authored the patient summary
... title SΣ 1..1 string Patient Summary
... 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 0..1 dateTime When the composition was attested
.... party S 0..1 Reference(AU PS Patient | AU PS RelatedPerson | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) Who attested the composition
... custodian SΣ 0..1 Reference(AU PS 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 | Composition (IPS) | AU PS Composition)
... Slices for event Σ 0..* BackboneElement The clinical service(s) being documented
Slice: Unordered, Open by pattern:code
.... event:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
.... event:careProvisioningEvent SΣ 0..1 BackboneElement The care provisioning 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 SΣ 1..1 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.



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://terminology.hl7.org/CodeSystem/v3-ActClass
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PCPR
....... 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
..... period SΣ 0..1 Period The period covered by the documentation
..... detail Σ 0..* Reference(Resource) The event(s) being documented
... Slices for section SC 3..* BackboneElement Sections composing the patient summary
Slice: Unordered, Open by pattern:code
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string Label for section (e.g. for ToC)
..... code 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 1..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 C 0..* Reference(Resource) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:sectionProblems SC 1..1 BackboneElement IPS Problems Section
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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 11450-4
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 1..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.

..... Slices for entry SC 0..* Reference(Condition | DocumentReference) Clinical problems or conditions currently being monitored for the patient.
Slice: Unordered, Open by profile:resolve()
...... entry:problem SC 0..* Reference(AU PS Condition) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:sectionAllergies SC 1..1 BackboneElement IPS Allergies and Intolerances Section
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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 48765-2
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 1..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.

..... Slices for entry SC 0..* Reference(AllergyIntolerance | DocumentReference) Relevant allergies or intolerances (conditions) for that patient.
Slice: Unordered, Open by profile:resolve()
...... entry:allergyOrIntolerance SC 0..* Reference(AU PS AllergyIntolerance) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:sectionMedications SC 1..1 BackboneElement IPS Medication Summary Section
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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Medication Summary section
..... code 1..1 CodeableConceptIPS 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: 10160-0
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 1..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.

..... Slices for entry SC 0..* Reference(MedicationStatement | MedicationRequest | MedicationAdministration | MedicationDispense | DocumentReference) Medications relevant for the scope of the patient summary
Slice: Unordered, Open by profile:resolve()
...... entry:medicationStatement SC 0..* Reference(AU PS MedicationStatement) A reference to data that supports this section
...... entry:medicationRequest SC 0..* Reference(AU PS MedicationRequest) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:sectionImmunizations SC 0..1 BackboneElement Immunizations Section
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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 11369-6
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 1..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.

..... Slices for entry SC 0..* Reference(Immunization | DocumentReference) Patient's immunization status and pertinent history.
Slice: Unordered, Open by profile:resolve()
...... entry:immunization SC 0..* Reference(AU PS Immunization) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredPattern: LOINC Code 60591-5
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.event:careProvisioningEvent.codeexamplePattern: PCPR
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:sectionProblems.codeexamplePattern: LOINC Code 11450-4
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionProblems.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:sectionProblems.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:sectionProblems.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:sectionAllergies.codeexamplePattern: LOINC Code 48765-2
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionAllergies.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:sectionAllergies.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:sectionAllergies.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:sectionMedications.codeexamplePattern: LOINC Code 10160-0
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionMedications.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:sectionMedications.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:sectionMedications.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:sectionImmunizations.codeexamplePattern: LOINC Code 11369-6
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionImmunizations.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:sectionImmunizations.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:sectionImmunizations.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:sectionProblems, Composition.section:sectionAllergies, Composition.section:sectionMedications, Composition.section:sectionImmunizationsA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:sectionProblems, Composition.section:sectionAllergies, Composition.section:sectionMedications, Composition.section:sectionImmunizationsA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseComposition

Summary

Mandatory: 12 elements(3 nested mandatory elements)
Must-Support: 36 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Composition.event
  • The element 1 is sliced based on the value of Composition.section
  • The element 1 is sliced based on the value of Composition.section.entry

Maturity: 0

Differential View

This structure is derived from AUBaseComposition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* AUBaseComposition Patient Summary composition
This profile also imposes the profile Composition (IPS)
... text S 0..1 Narrative Text summary of the resource, for human interpretation
... identifier S 0..1 Identifier Version-independent identifier for the Composition
... status S 1..1 code preliminary | final | amended | entered-in-error
.... 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: 60591-5
... subject S 1..1 Reference(AU PS Patient) Who and/or what the composition is about
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... date S 1..1 dateTime Composition editing time
... author S 1..* Reference(AU PS Practitioner | AU PS PractitionerRole | Device | AU PS Patient | AU PS RelatedPerson | AU PS Organization) Who and/or what authored the patient summary
... title S 1..1 string Patient Summary
... attester S 0..* BackboneElement Attests to accuracy of composition
.... mode S 1..1 code personal | professional | legal | official
.... time S 0..1 dateTime When the composition was attested
.... party S 0..1 Reference(AU PS Patient | AU PS RelatedPerson | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) Who attested the composition
... custodian S 0..1 Reference(AU PS Organization) Organization which maintains the composition
... relatesTo
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition | Composition (IPS) | AU PS Composition)
... Slices for event 0..* BackboneElement The clinical service(s) being documented
Slice: Unordered, Open by pattern:code
.... event:careProvisioningEvent S 0..1 BackboneElement The care provisioning being documented
..... code S 1..1 CodeableConcept Code(s) that apply to the event being documented
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://terminology.hl7.org/CodeSystem/v3-ActClass
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PCPR
..... period S 0..1 Period The period covered by the documentation
... Slices for section S 3..* BackboneElement Sections composing the patient summary
Slice: Unordered, Open by pattern:code
.... section:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... text S 1..1 Narrative Text summary of the section, for human interpretation
..... section 0..0
.... section:sectionProblems S 1..1 BackboneElement IPS Problems Section
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 11450-4
..... Slices for entry S 0..* Reference(Condition | DocumentReference) Clinical problems or conditions currently being monitored for the patient.
Slice: Unordered, Open by profile:resolve()
...... entry:problem S 0..* Reference(AU PS Condition) A reference to data that supports this section
.... section:sectionAllergies S 1..1 BackboneElement IPS Allergies and Intolerances Section
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 48765-2
..... Slices for entry S 0..* Reference(AllergyIntolerance | DocumentReference) Relevant allergies or intolerances (conditions) for that patient.
Slice: Unordered, Open by profile:resolve()
...... entry:allergyOrIntolerance S 0..* Reference(AU PS AllergyIntolerance) A reference to data that supports this section
.... section:sectionMedications S 1..1 BackboneElement IPS Medication Summary Section
..... title S 1..1 string Medication Summary section
..... code 1..1 CodeableConceptIPS 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: 10160-0
..... Slices for entry S 0..* Reference(MedicationStatement | MedicationRequest | MedicationAdministration | MedicationDispense | DocumentReference) Medications relevant for the scope of the patient summary
Slice: Unordered, Open by profile:resolve()
...... entry:medicationStatement S 0..* Reference(AU PS MedicationStatement) A reference to data that supports this section
...... entry:medicationRequest S 0..* Reference(AU PS MedicationRequest) A reference to data that supports this section
.... section:sectionImmunizations S 0..1 BackboneElement Immunizations Section
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 11369-6
..... Slices for entry S 0..* Reference(Immunization | DocumentReference) Patient's immunization status and pertinent history.
Slice: Unordered, Open by profile:resolve()
...... entry:immunization S 0..* Reference(AU PS Immunization) A reference to data that supports this section

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* AUBaseComposition Patient Summary composition
This profile also imposes the profile Composition (IPS)
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... text S 0..1 Narrative Text summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:informationRecipient 0..* Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) Who and/or what should receive a copy of the composition
URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..1 Identifier Version-independent identifier for the Composition
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.


ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 CodeableConceptIPS Kind of composition ("Patient Summary")
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.


ele-1: All FHIR elements must have a @value or children
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: 60591-5
... subject SΣ 1..1 Reference(AU PS Patient) Who and/or what the composition is about
ele-1: All FHIR elements must have a @value or children
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Composition editing time
ele-1: All FHIR elements must have a @value or children
... author SΣ 1..* Reference(AU PS Practitioner | AU PS PractitionerRole | Device | AU PS Patient | AU PS RelatedPerson | AU PS Organization) Who and/or what authored the patient summary
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Patient Summary
ele-1: All FHIR elements must have a @value or children
... attester S 0..* BackboneElement Attests to accuracy of composition
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... mode S 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


ele-1: All FHIR elements must have a @value or children
.... time S 0..1 dateTime When the composition was attested
ele-1: All FHIR elements must have a @value or children
.... party S 0..1 Reference(AU PS Patient | AU PS RelatedPerson | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) Who attested the composition
ele-1: All FHIR elements must have a @value or children
... custodian SΣ 0..1 Reference(AU PS Organization) Organization which maintains the composition
ele-1: All FHIR elements must have a @value or children
... Slices for event Σ 0..* BackboneElement The clinical service(s) being documented
Slice: Unordered, Open by pattern:code
ele-1: All FHIR elements must have a @value or children
.... event:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... event:careProvisioningEvent SΣ 0..1 BackboneElement The care provisioning being documented
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code SΣ 1..1 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.


ele-1: All FHIR elements must have a @value or children

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://terminology.hl7.org/CodeSystem/v3-ActClass
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PCPR
..... period SΣ 0..1 Period The period covered by the documentation
ele-1: All FHIR elements must have a @value or children
... Slices for section SC 3..* BackboneElement Sections composing the patient summary
Slice: Unordered, Open by pattern:code
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
ele-1: All FHIR elements must have a @value or children
.... section:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
.... section:sectionProblems SC 1..1 BackboneElement IPS Problems Section
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
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title S 1..1 string Label for section (e.g. for ToC)
ele-1: All FHIR elements must have a @value or children
..... code 1..1 CodeableConceptIPS Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


ele-1: All FHIR elements must have a @value or children
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: 11450-4
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
..... Slices for entry SC 0..* Reference(Condition | DocumentReference) Clinical problems or conditions currently being monitored for the patient.
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
...... entry:problem SC 0..* Reference(AU PS Condition) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
.... section:sectionAllergies SC 1..1 BackboneElement IPS Allergies and Intolerances Section
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
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title S 1..1 string Label for section (e.g. for ToC)
ele-1: All FHIR elements must have a @value or children
..... code 1..1 CodeableConceptIPS Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


ele-1: All FHIR elements must have a @value or children
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: 48765-2
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
..... Slices for entry SC 0..* Reference(AllergyIntolerance | DocumentReference) Relevant allergies or intolerances (conditions) for that patient.
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
...... entry:allergyOrIntolerance SC 0..* Reference(AU PS AllergyIntolerance) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
.... section:sectionMedications SC 1..1 BackboneElement IPS Medication Summary Section
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
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title S 1..1 string Medication Summary section
ele-1: All FHIR elements must have a @value or children
..... code 1..1 CodeableConceptIPS Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


ele-1: All FHIR elements must have a @value or children
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: 10160-0
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
..... Slices for entry SC 0..* Reference(MedicationStatement | MedicationRequest | MedicationAdministration | MedicationDispense | DocumentReference) Medications relevant for the scope of the patient summary
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
...... entry:medicationStatement SC 0..* Reference(AU PS MedicationStatement) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
...... entry:medicationRequest SC 0..* Reference(AU PS MedicationRequest) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children
.... section:sectionImmunizations SC 0..1 BackboneElement Immunizations Section
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
ele-1: All FHIR elements must have a @value or children
..... Slices for extension Content/Rules for all slices
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... title S 1..1 string Label for section (e.g. for ToC)
ele-1: All FHIR elements must have a @value or children
..... code 1..1 CodeableConceptIPS Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.


ele-1: All FHIR elements must have a @value or children
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: 11369-6
..... text SC 1..1 Narrative Text summary of the section, for human interpretation
ele-1: All FHIR elements must have a @value or children
..... Slices for entry SC 0..* Reference(Immunization | DocumentReference) Patient's immunization status and pertinent history.
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
...... entry:immunization SC 0..* Reference(AU PS Immunization) A reference to data that supports this section
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredPattern: LOINC Code 60591-5
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.event:careProvisioningEvent.codeexamplePattern: PCPR
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section:sectionProblems.codeexamplePattern: LOINC Code 11450-4
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionAllergies.codeexamplePattern: LOINC Code 48765-2
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionMedications.codeexamplePattern: LOINC Code 10160-0
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionImmunizations.codeexamplePattern: LOINC Code 11369-6
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:sectionProblems, Composition.section:sectionAllergies, Composition.section:sectionMedications, Composition.section:sectionImmunizationsA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:sectionProblems, Composition.section:sectionAllergies, Composition.section:sectionMedications, Composition.section:sectionImmunizationsA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* AUBaseComposition Patient Summary composition
This profile also imposes the profile Composition (IPS)
... 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
... text S 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
.... extension:informationRecipient 0..* Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) Who and/or what should receive a copy of the composition
URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..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 CodeableConceptIPS Kind of composition ("Patient Summary")
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: 60591-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
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ 1..1 Reference(AU PS Patient) Who and/or what the composition is about
.... 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 SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date SΣ 1..1 dateTime Composition editing time
... author SΣ 1..* Reference(AU PS Practitioner | AU PS PractitionerRole | Device | AU PS Patient | AU PS RelatedPerson | AU PS Organization) Who and/or what authored the patient summary
... title SΣ 1..1 string Patient Summary
... 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 0..1 dateTime When the composition was attested
.... party S 0..1 Reference(AU PS Patient | AU PS RelatedPerson | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) Who attested the composition
... custodian SΣ 0..1 Reference(AU PS 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 | Composition (IPS) | AU PS Composition)
... Slices for event Σ 0..* BackboneElement The clinical service(s) being documented
Slice: Unordered, Open by pattern:code
.... event:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
.... event:careProvisioningEvent SΣ 0..1 BackboneElement The care provisioning 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 SΣ 1..1 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.



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://terminology.hl7.org/CodeSystem/v3-ActClass
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PCPR
....... 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
..... period SΣ 0..1 Period The period covered by the documentation
..... detail Σ 0..* Reference(Resource) The event(s) being documented
... Slices for section SC 3..* BackboneElement Sections composing the patient summary
Slice: Unordered, Open by pattern:code
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 0..1 string Label for section (e.g. for ToC)
..... code 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 1..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 C 0..* Reference(Resource) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:sectionProblems SC 1..1 BackboneElement IPS Problems Section
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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 11450-4
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 1..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.

..... Slices for entry SC 0..* Reference(Condition | DocumentReference) Clinical problems or conditions currently being monitored for the patient.
Slice: Unordered, Open by profile:resolve()
...... entry:problem SC 0..* Reference(AU PS Condition) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:sectionAllergies SC 1..1 BackboneElement IPS Allergies and Intolerances Section
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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 48765-2
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 1..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.

..... Slices for entry SC 0..* Reference(AllergyIntolerance | DocumentReference) Relevant allergies or intolerances (conditions) for that patient.
Slice: Unordered, Open by profile:resolve()
...... entry:allergyOrIntolerance SC 0..* Reference(AU PS AllergyIntolerance) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:sectionMedications SC 1..1 BackboneElement IPS Medication Summary Section
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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Medication Summary section
..... code 1..1 CodeableConceptIPS 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: 10160-0
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 1..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.

..... Slices for entry SC 0..* Reference(MedicationStatement | MedicationRequest | MedicationAdministration | MedicationDispense | DocumentReference) Medications relevant for the scope of the patient summary
Slice: Unordered, Open by profile:resolve()
...... entry:medicationStatement SC 0..* Reference(AU PS MedicationStatement) A reference to data that supports this section
...... entry:medicationRequest SC 0..* Reference(AU PS MedicationRequest) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section:sectionImmunizations SC 0..1 BackboneElement Immunizations Section
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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:section-note 0..1 Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConceptIPS 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: 11369-6
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 1..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.

..... Slices for entry SC 0..* Reference(Immunization | DocumentReference) Patient's immunization status and pertinent history.
Slice: Unordered, Open by profile:resolve()
...... entry:immunization SC 0..* Reference(AU PS Immunization) A reference to data that supports this section
..... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
Composition.typepreferredPattern: LOINC Code 60591-5
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
Composition.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Composition.confidentialityrequiredv3.ConfidentialityClassification
http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26
from the FHIR Standard
Composition.attester.moderequiredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
from the FHIR Standard
Composition.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
Composition.event.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.event:careProvisioningEvent.codeexamplePattern: PCPR
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:sectionProblems.codeexamplePattern: LOINC Code 11450-4
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionProblems.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:sectionProblems.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:sectionProblems.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:sectionAllergies.codeexamplePattern: LOINC Code 48765-2
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionAllergies.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:sectionAllergies.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:sectionAllergies.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:sectionMedications.codeexamplePattern: LOINC Code 10160-0
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionMedications.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:sectionMedications.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:sectionMedications.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section:sectionImmunizations.codeexamplePattern: LOINC Code 11369-6
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section:sectionImmunizations.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Composition.section:sectionImmunizations.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section:sectionImmunizations.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.section, Composition.section:sectionProblems, Composition.section:sectionAllergies, Composition.section:sectionMedications, Composition.section:sectionImmunizationsA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.section, Composition.section:sectionProblems, Composition.section:sectionAllergies, Composition.section:sectionMedications, Composition.section:sectionImmunizationsA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseComposition

Summary

Mandatory: 12 elements(3 nested mandatory elements)
Must-Support: 36 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Composition.event
  • The element 1 is sliced based on the value of Composition.section
  • The element 1 is sliced based on the value of Composition.section.entry

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron