Kenya Patient Summary Implementation Guide
0.1.0 - ci-build Kenya flag

Kenya Patient Summary Implementation Guide, published by Digital Health Agency (DHA), Kenya. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/Kenya-Patient-Summary-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: Composition Profile - KPS

Official URL: https://fhir.dha.go.ke/ig/patient-summary/StructureDefinition/ke-kps-composition Version: 0.1.0
Draft as of 2026-08-12 Computable Name: KpsComposition

Copyright/Legal: Copyright © 2024+ Digital Health Agency of Kenya. This content is licensed under Creative Commons Zero v1.0 Universal (CC0 1.0). No rights reserved.

This profile defines constraints on the Composition resource for use within the Kenya Patient Summary. It represents the document header binding together the sections and clinical resources (problems, allergies, medications, immunizations, results, and procedures) that constitute a patient summary exchanged within the national Health Information Exchange (HIE).

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-composition|0.1.0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!SΣ 1..1 code Status of this composition (preliminary | final | amended | entered-in-error)
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConcept 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 1..1 string Representation defined by the system
Fixed Value: Patient summary Document
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Patient Profile - KPS) The patient this summary is about
... encounter SΣ 0..1 Reference(Encounter Profile - KPS) Encounter associated with this summary, if any
... date SΣ 1..1 dateTime Date and time the summary was generated
... author SΣ 1..* Reference(Practitioner Profile - KPS | Practitioner Role Profile - KPS | Organization Profile - KPS) Who produced this patient summary
... title SΣ 1..1 string Human-readable title, e.g. patient name and generation date
... attester S 0..* BackboneElement Attests to accuracy of composition
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode S 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
.... time S 0..1 dateTime When the composition was attested
.... party S 0..1 Reference(Practitioner Profile - KPS | Organization Profile - KPS) Who attested the composition
... custodian SΣ 0..1 Reference(Organization Profile - KPS) Organization responsible for maintaining this summary
... Slices for section SC 3..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by pattern:code
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... section:problems SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11450-4
....... display 1..1 string Representation defined by the system
Fixed Value: Problem list
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(Condition Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:allergies SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 48765-2
....... display 1..1 string Representation defined by the system
Fixed Value: Allergies and adverse reactions
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(AllergyIntolerance Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:medications SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 10160-0
....... display 1..1 string Representation defined by the system
Fixed Value: History of Medication use
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(MedicationStatement Profile - KPS | MediacationRequest Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:immunizations SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 1..1 string Representation defined by the system
Fixed Value: History of immunization
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(Immunization Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:results SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30954-2
....... display 1..1 string Representation defined by the system
Fixed Value: Relevant diagnostic tests/laboratory data
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(Observation Profile - KPS | Diagnostic Report Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:procedures SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47519-4
....... display 1..1 string Representation defined by the system
Fixed Value: History of Procedures
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(Procedure Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.section:problems.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:problems.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:allergies.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:allergies.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:medications.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:medications.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:immunizations.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:immunizations.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:results.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:results.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:procedures.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:procedures.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section, Composition.section:problems, Composition.section:allergies, Composition.section:medications, Composition.section:immunizations, Composition.section:results, Composition.section:procedures A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section, Composition.section:problems, Composition.section:allergies, Composition.section:medications, Composition.section:immunizations, Composition.section:results, Composition.section:procedures A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id S 1..1 id Logical id of this artifact
... meta S 1..1 Meta Metadata about the resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-composition|0.1.0
... status S 1..1 code Status of this composition (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
..... display 1..1 string Representation defined by the system
Fixed Value: Patient summary Document
... subject S 1..1 Reference(Patient Profile - KPS) The patient this summary is about
... encounter S 0..1 Reference(Encounter Profile - KPS) Encounter associated with this summary, if any
... date S 1..1 dateTime Date and time the summary was generated
... author S 1..* Reference(Practitioner Profile - KPS | Practitioner Role Profile - KPS | Organization Profile - KPS) Who produced this patient summary
... title S 1..1 string Human-readable title, e.g. patient name and generation date
... 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(Practitioner Profile - KPS | Organization Profile - KPS) Who attested the composition
... custodian S 0..1 Reference(Organization Profile - KPS) Organization responsible for maintaining this summary
... Slices for section S 3..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by pattern:code
.... section:problems S 1..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11450-4
....... display 1..1 string Representation defined by the system
Fixed Value: Problem list
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(Condition Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:allergies S 1..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 48765-2
....... display 1..1 string Representation defined by the system
Fixed Value: Allergies and adverse reactions
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(AllergyIntolerance Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:medications S 1..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 10160-0
....... display 1..1 string Representation defined by the system
Fixed Value: History of Medication use
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(MedicationStatement Profile - KPS | MediacationRequest Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:immunizations S 0..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 1..1 string Representation defined by the system
Fixed Value: History of immunization
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(Immunization Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:results S 0..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30954-2
....... display 1..1 string Representation defined by the system
Fixed Value: Relevant diagnostic tests/laboratory data
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(Observation Profile - KPS | Diagnostic Report Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:procedures S 0..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47519-4
....... display 1..1 string Representation defined by the system
Fixed Value: History of Procedures
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(Procedure Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-composition|0.1.0
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Version-independent identifier for the Composition
... status ?!SΣ 1..1 code Status of this composition (preliminary | final | amended | entered-in-error)
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConcept 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 1..1 string Representation defined by the system
Fixed Value: Patient summary Document
..... 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(Patient Profile - KPS) The patient this summary is about
... encounter SΣ 0..1 Reference(Encounter Profile - KPS) Encounter associated with this summary, if any
... date SΣ 1..1 dateTime Date and time the summary was generated
... author SΣ 1..* Reference(Practitioner Profile - KPS | Practitioner Role Profile - KPS | Organization Profile - KPS) Who produced this patient summary
... title SΣ 1..1 string Human-readable title, e.g. patient name and generation date
... 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(Practitioner Profile - KPS | Organization Profile - KPS) Who attested the composition
... custodian SΣ 0..1 Reference(Organization Profile - KPS) Organization responsible for maintaining this summary
... relatesTo 0..* BackboneElement Relationships to other compositions/documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* Reference(Resource) The event(s) being documented
... Slices for section SC 3..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by pattern:code
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... 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 C 0..* See section (Composition) Nested Section
.... section:problems SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11450-4
....... display 1..1 string Representation defined by the system
Fixed Value: Problem list
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Condition Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:allergies SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 48765-2
....... display 1..1 string Representation defined by the system
Fixed Value: Allergies and adverse reactions
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(AllergyIntolerance Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:medications SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 10160-0
....... display 1..1 string Representation defined by the system
Fixed Value: History of Medication use
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(MedicationStatement Profile - KPS | MediacationRequest Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:immunizations SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 1..1 string Representation defined by the system
Fixed Value: History of immunization
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Immunization Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:results SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30954-2
....... display 1..1 string Representation defined by the system
Fixed Value: Relevant diagnostic tests/laboratory data
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Observation Profile - KPS | Diagnostic Report Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:procedures SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47519-4
....... display 1..1 string Representation defined by the system
Fixed Value: History of Procedures
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Procedure Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Composition.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v7.3
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:problems.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:problems.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:problems.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:problems.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:allergies.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:allergies.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:allergies.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:allergies.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:medications.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:medications.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:medications.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:medications.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:immunizations.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:immunizations.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:immunizations.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:immunizations.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:results.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:results.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:results.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:results.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:procedures.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:procedures.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:procedures.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:procedures.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section, Composition.section:problems, Composition.section:allergies, Composition.section:medications, Composition.section:immunizations, Composition.section:results, Composition.section:procedures A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section, Composition.section:problems, Composition.section:allergies, Composition.section:medications, Composition.section:immunizations, Composition.section:results, Composition.section:procedures A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 13 elements(6 nested mandatory elements)
Must-Support: 45 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-composition|0.1.0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!SΣ 1..1 code Status of this composition (preliminary | final | amended | entered-in-error)
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConcept 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 1..1 string Representation defined by the system
Fixed Value: Patient summary Document
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Patient Profile - KPS) The patient this summary is about
... encounter SΣ 0..1 Reference(Encounter Profile - KPS) Encounter associated with this summary, if any
... date SΣ 1..1 dateTime Date and time the summary was generated
... author SΣ 1..* Reference(Practitioner Profile - KPS | Practitioner Role Profile - KPS | Organization Profile - KPS) Who produced this patient summary
... title SΣ 1..1 string Human-readable title, e.g. patient name and generation date
... attester S 0..* BackboneElement Attests to accuracy of composition
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode S 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
.... time S 0..1 dateTime When the composition was attested
.... party S 0..1 Reference(Practitioner Profile - KPS | Organization Profile - KPS) Who attested the composition
... custodian SΣ 0..1 Reference(Organization Profile - KPS) Organization responsible for maintaining this summary
... Slices for section SC 3..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by pattern:code
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... section:problems SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11450-4
....... display 1..1 string Representation defined by the system
Fixed Value: Problem list
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(Condition Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:allergies SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 48765-2
....... display 1..1 string Representation defined by the system
Fixed Value: Allergies and adverse reactions
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(AllergyIntolerance Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:medications SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 10160-0
....... display 1..1 string Representation defined by the system
Fixed Value: History of Medication use
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(MedicationStatement Profile - KPS | MediacationRequest Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:immunizations SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 1..1 string Representation defined by the system
Fixed Value: History of immunization
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(Immunization Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:results SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30954-2
....... display 1..1 string Representation defined by the system
Fixed Value: Relevant diagnostic tests/laboratory data
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(Observation Profile - KPS | Diagnostic Report Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section:procedures SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... 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 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47519-4
....... display 1..1 string Representation defined by the system
Fixed Value: History of Procedures
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... entry SC 0..* Reference(Procedure Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.section:problems.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:problems.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:allergies.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:allergies.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:medications.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:medications.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:immunizations.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:immunizations.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:results.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:results.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:procedures.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:procedures.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section, Composition.section:problems, Composition.section:allergies, Composition.section:medications, Composition.section:immunizations, Composition.section:results, Composition.section:procedures A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section, Composition.section:problems, Composition.section:allergies, Composition.section:medications, Composition.section:immunizations, Composition.section:results, Composition.section:procedures A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id S 1..1 id Logical id of this artifact
... meta S 1..1 Meta Metadata about the resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-composition|0.1.0
... status S 1..1 code Status of this composition (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
..... display 1..1 string Representation defined by the system
Fixed Value: Patient summary Document
... subject S 1..1 Reference(Patient Profile - KPS) The patient this summary is about
... encounter S 0..1 Reference(Encounter Profile - KPS) Encounter associated with this summary, if any
... date S 1..1 dateTime Date and time the summary was generated
... author S 1..* Reference(Practitioner Profile - KPS | Practitioner Role Profile - KPS | Organization Profile - KPS) Who produced this patient summary
... title S 1..1 string Human-readable title, e.g. patient name and generation date
... 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(Practitioner Profile - KPS | Organization Profile - KPS) Who attested the composition
... custodian S 0..1 Reference(Organization Profile - KPS) Organization responsible for maintaining this summary
... Slices for section S 3..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by pattern:code
.... section:problems S 1..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11450-4
....... display 1..1 string Representation defined by the system
Fixed Value: Problem list
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(Condition Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:allergies S 1..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 48765-2
....... display 1..1 string Representation defined by the system
Fixed Value: Allergies and adverse reactions
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(AllergyIntolerance Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:medications S 1..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 10160-0
....... display 1..1 string Representation defined by the system
Fixed Value: History of Medication use
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(MedicationStatement Profile - KPS | MediacationRequest Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:immunizations S 0..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 1..1 string Representation defined by the system
Fixed Value: History of immunization
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(Immunization Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:results S 0..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30954-2
....... display 1..1 string Representation defined by the system
Fixed Value: Relevant diagnostic tests/laboratory data
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(Observation Profile - KPS | Diagnostic Report Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty
.... section:procedures S 0..1 BackboneElement Composition is broken into sections
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47519-4
....... display 1..1 string Representation defined by the system
Fixed Value: History of Procedures
..... text S 0..1 Narrative Text summary of the section, for human interpretation
..... entry S 0..* Reference(Procedure Profile - KPS) A reference to data that supports this section
..... emptyReason S 0..1 CodeableConcept Why the section is empty

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-composition|0.1.0
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Version-independent identifier for the Composition
... status ?!SΣ 1..1 code Status of this composition (preliminary | final | amended | entered-in-error)
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type SΣ 1..1 CodeableConcept 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 1..1 string Representation defined by the system
Fixed Value: Patient summary Document
..... 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(Patient Profile - KPS) The patient this summary is about
... encounter SΣ 0..1 Reference(Encounter Profile - KPS) Encounter associated with this summary, if any
... date SΣ 1..1 dateTime Date and time the summary was generated
... author SΣ 1..* Reference(Practitioner Profile - KPS | Practitioner Role Profile - KPS | Organization Profile - KPS) Who produced this patient summary
... title SΣ 1..1 string Human-readable title, e.g. patient name and generation date
... 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(Practitioner Profile - KPS | Organization Profile - KPS) Who attested the composition
... custodian SΣ 0..1 Reference(Organization Profile - KPS) Organization responsible for maintaining this summary
... relatesTo 0..* BackboneElement Relationships to other compositions/documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* Reference(Resource) The event(s) being documented
... Slices for section SC 3..* BackboneElement Composition is broken into sections
Slice: Unordered, Open by pattern:code
Constraints: cmp-1, cmp-2
.... section:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 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 C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... 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 C 0..* See section (Composition) Nested Section
.... section:problems SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11450-4
....... display 1..1 string Representation defined by the system
Fixed Value: Problem list
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Condition Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:allergies SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 48765-2
....... display 1..1 string Representation defined by the system
Fixed Value: Allergies and adverse reactions
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(AllergyIntolerance Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:medications SC 1..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 10160-0
....... display 1..1 string Representation defined by the system
Fixed Value: History of Medication use
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(MedicationStatement Profile - KPS | MediacationRequest Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:immunizations SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 11369-6
....... display 1..1 string Representation defined by the system
Fixed Value: History of immunization
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Immunization Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:results SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30954-2
....... display 1..1 string Representation defined by the system
Fixed Value: Relevant diagnostic tests/laboratory data
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Observation Profile - KPS | Diagnostic Report Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section
.... section:procedures SC 0..1 BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title S 1..1 string Label for section (e.g. for ToC)
..... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47519-4
....... display 1..1 string Representation defined by the system
Fixed Value: History of Procedures
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
..... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
..... text SC 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
..... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
..... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
..... entry SC 0..* Reference(Procedure Profile - KPS) A reference to data that supports this section
..... emptyReason SC 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
..... section C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Composition.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v7.3
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:problems.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:problems.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:problems.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:problems.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:allergies.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:allergies.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:allergies.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:allergies.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:medications.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:medications.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:medications.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:medications.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:immunizations.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:immunizations.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:immunizations.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:immunizations.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:results.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:results.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:results.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:results.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.
Composition.section:procedures.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section:procedures.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section:procedures.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section:procedures.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section, Composition.section:problems, Composition.section:allergies, Composition.section:medications, Composition.section:immunizations, Composition.section:results, Composition.section:procedures A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section, Composition.section:problems, Composition.section:allergies, Composition.section:medications, Composition.section:immunizations, Composition.section:results, Composition.section:procedures A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Composition

Summary

Mandatory: 13 elements(6 nested mandatory elements)
Must-Support: 45 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron