CH ORF (R4)
2.0.0-ballot - ballot
CH ORF (R4)
2.0.0-ballot - ballot
This page is part of the CH ORF (R4) (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Official URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-composition | Version: 2.0.0-ballot | |||
| Active as of 2023-06-29 | Computable Name: ChOrfComposition | |||
Copyright/Legal: CC0-1.0 |
||||
Profile to specify how the generic elements (e.g. patient, author) and the healthcare domain specific elements must be structured in the Composition as the first entry of the document.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHCoreComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | 0..* | CHCoreComposition | CH ORF Composition | |
  text | S | 1..1 | Narrative | Narrative text of the composition |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 dataEnterer | S | 0..1 | (Complex) | The person/organization who has typed/filled in the form content URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer |
| urgentNoficationContactForThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactforthisdocument |
| urgentNoficationContactForTheResponseToThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters about the response URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactfortheresponsetothisdocument |
| receiver | S | 0..1 | Reference(CH Core PractitionerRole) | Person/organization who receives the document URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-receiver |
| copyReceiver | S | 0..* | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Person/organization who receives the copy of this order (shall receive also all results therefrom) URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-copyreceiver |
| precedentDocument | S | 0..1 | Identifier | Identifier of the document which precedes this document in a thread. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-precedentdocument |
| antecedentEpisodeOfCare | S | 0..1 | Reference(CH ORF Episode of Care) | Documentation of the antecedent episode of care e.g hospitalisation in case of care transfer between instituitons e.g. hospitals, rehab. clinics, retirement homes etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-antecedentepisodeofcare |
| initiator | S | 0..1 | (Complex) | Profile to specify who intiated this order; in particulars for spitex and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-initiator |
| patientConsent | S | 0..1 | Reference(CH ORF Consent) | To specify if the patient gave an informed consent to this order; in particulars for spitex
and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-patientconsent |
| status | S | 1..1 | code | preliminary | final | amended | entered-in-error |
| type | S | 1..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) |
| category | S | 1..1 | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) |
| subject | S | 1..1 | Reference(CH Core Patient) | Patient as the principle target of a particular form content |
 author | S | 1..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content |
| title | S | 1..1 | string | Meaningful title |
  Slices for section | S | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code |
  section:orderReferral | S | 1..1 | BackboneElement | Contains the data that supports the order and referral by form. |
  title | S | 1..1 | string | Order-Referral |
 code | S | 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: 93037-0 | |
| text | S | 0..1 | Narrative | Text summary of the section, for human interpretation |
| Slices for entry | S | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:Questionnaire | S | 0..1 | Reference(CH ORF Questionnaire) | Questionnaire |
 reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:QuestionnaireResponse | S | 0..1 | Reference(CH ORF QuestionnaireResponse) | QuestionnaireResponse |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:ServiceRequest | S | 1..* | Reference(CH ORF ServiceRequest) | ServiceRequest |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
 entry:DocumentReference | S | 0..* | Reference(CH ORF DocumentReference) | DocumentReference |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| section | 0..0 | |||
| section:originalRepresentation | S | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. |
| title | S | 1..1 | string | Original representation |
| code | S | 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: 55108-5 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Clinical presentation Document | |
| text | S | 1..1 | Narrative | Representation of the original view |
| entry | S | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. |
| section | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Composition.type | preferred | DocumentEntryTypeCode |
| Composition.category | preferred | DocumentEntryClassCode |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH ORF Composition | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 text | S | 1..1 | Narrative | Narrative text of the composition |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| dataEnterer | S | 0..1 | (Complex) | The person/organization who has typed/filled in the form content URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer |
| urgentNoficationContactForThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactforthisdocument |
| urgentNoficationContactForTheResponseToThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters about the response URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactfortheresponsetothisdocument |
| receiver | S | 0..1 | Reference(CH Core PractitionerRole) | Person/organization who receives the document URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-receiver |
| copyReceiver | S | 0..* | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Person/organization who receives the copy of this order (shall receive also all results therefrom) URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-copyreceiver |
| precedentDocument | S | 0..1 | Identifier | Identifier of the document which precedes this document in a thread. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-precedentdocument |
| antecedentEpisodeOfCare | S | 0..1 | Reference(CH ORF Episode of Care) | Documentation of the antecedent episode of care e.g hospitalisation in case of care transfer between instituitons e.g. hospitals, rehab. clinics, retirement homes etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-antecedentepisodeofcare |
| initiator | S | 0..1 | (Complex) | Profile to specify who intiated this order; in particulars for spitex and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-initiator |
| patientConsent | S | 0..1 | Reference(CH ORF Consent) | To specify if the patient gave an informed consent to this order; in particulars for spitex
and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-patientconsent |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type | SΣ | 1..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) |
| category | SΣ | 1..1 | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) |
 subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient as the principle target of a particular form content |
 reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | SΣ | 1..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| title | SΣ | 1..1 | string | Meaningful title |
| Slices for section | SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code |
| section:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| section:orderReferral | SC | 1..1 | BackboneElement | Contains the data that supports the order and referral by form. |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | S | 1..1 | string | Order-Referral |
| code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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: 93037-0 | |
| text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
 Slices for entry | SC | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:Questionnaire | SC | 0..1 | Reference(CH ORF Questionnaire) | Questionnaire |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:QuestionnaireResponse | SC | 0..1 | Reference(CH ORF QuestionnaireResponse) | QuestionnaireResponse |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:ServiceRequest | SC | 1..* | Reference(CH ORF ServiceRequest) | ServiceRequest |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:DocumentReference | SC | 0..* | Reference(CH ORF DocumentReference) | DocumentReference |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| section:originalRepresentation | SC | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | S | 1..1 | string | Original representation |
| code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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: 55108-5 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Clinical presentation Document | |
| text | SC | 1..1 | Narrative | Representation of the original view |
| entry | SC | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | DocumentEntryTypeCode |
| Composition.category | preferred | DocumentEntryClassCode |
| Composition.section:orderReferral.code | example | Pattern: LOINC code 93037-0 |
| Composition.section:originalRepresentation.code | example | Pattern: LOINC code 55108-5("Clinical presentation Document") |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:orderReferral, Composition.section:originalRepresentation | 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:orderReferral, Composition.section:originalRepresentation | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH ORF Composition | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | S | 1..1 | Narrative | Narrative text of the composition | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dataEnterer | S | 0..1 | (Complex) | The person/organization who has typed/filled in the form content URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer | ||||
| urgentNoficationContactForThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactforthisdocument | ||||
| urgentNoficationContactForTheResponseToThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters about the response URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactfortheresponsetothisdocument | ||||
| receiver | S | 0..1 | Reference(CH Core PractitionerRole) | Person/organization who receives the document URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-receiver | ||||
| copyReceiver | S | 0..* | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Person/organization who receives the copy of this order (shall receive also all results therefrom) URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-copyreceiver | ||||
| precedentDocument | S | 0..1 | Identifier | Identifier of the document which precedes this document in a thread. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-precedentdocument | ||||
| antecedentEpisodeOfCare | S | 0..1 | Reference(CH ORF Episode of Care) | Documentation of the antecedent episode of care e.g hospitalisation in case of care transfer between instituitons e.g. hospitals, rehab. clinics, retirement homes etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-antecedentepisodeofcare | ||||
| initiator | S | 0..1 | (Complex) | Profile to specify who intiated this order; in particulars for spitex and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-initiator | ||||
| patientConsent | S | 0..1 | Reference(CH ORF Consent) | To specify if the patient gave an informed consent to this order; in particulars for spitex
and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-patientconsent | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | SΣ | 1..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) | ||||
| category | SΣ | 1..1 | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) | ||||
| subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient as the principle target of a particular form content | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter | Σ | 0..1 | Reference(CH Core Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | SΣ | 1..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| title | SΣ | 1..1 | string | Meaningful title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Who attested the composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| custodian | Σ | 0..1 | Reference(CH Core Organization) | Organization which maintains the composition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| 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(CH Core 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 | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code | ||||
| 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(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core 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 | ||||
| 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:orderReferral | SC | 1..1 | BackboneElement | Contains the data that supports the order and referral by form. | ||||
| 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 | Order-Referral | ||||
| code | S | 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: 93037-0 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| author | 0..* | Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| Slices for entry | SC | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() | ||||
| entry:Questionnaire | SC | 0..1 | Reference(CH ORF Questionnaire) | Questionnaire | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| entry:QuestionnaireResponse | SC | 0..1 | Reference(CH ORF QuestionnaireResponse) | QuestionnaireResponse | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| entry:ServiceRequest | SC | 1..* | Reference(CH ORF ServiceRequest) | ServiceRequest | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| entry:DocumentReference | SC | 0..* | Reference(CH ORF DocumentReference) | DocumentReference | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section:originalRepresentation | SC | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. | ||||
| 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 | Original representation | ||||
| code | S | 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: 55108-5 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Clinical presentation Document | |||||
| 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(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | SC | 1..1 | Narrative | Representation of the original view | ||||
| 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 | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | preferred | DocumentEntryTypeCode | ||||
| Composition.category | preferred | DocumentEntryClassCode | ||||
| Composition.subject.type | extensible | ResourceType | ||||
| Composition.author.type | extensible | ResourceType | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.attester.party.type | extensible | ResourceType | ||||
| Composition.custodian.type | extensible | ResourceType | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | ListMode | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:orderReferral.code | example | Pattern: LOINC code 93037-0 | ||||
| Composition.section:orderReferral.mode | required | ListMode | ||||
| Composition.section:orderReferral.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:orderReferral.entry:Questionnaire.type | extensible | ResourceType | ||||
| Composition.section:orderReferral.entry:QuestionnaireResponse.type | extensible | ResourceType | ||||
| Composition.section:orderReferral.entry:ServiceRequest.type | extensible | ResourceType | ||||
| Composition.section:orderReferral.entry:DocumentReference.type | extensible | ResourceType | ||||
| Composition.section:orderReferral.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:originalRepresentation.code | example | Pattern: LOINC code 55108-5("Clinical presentation Document") | ||||
| Composition.section:originalRepresentation.mode | required | ListMode | ||||
| Composition.section:originalRepresentation.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:originalRepresentation.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:orderReferral, Composition.section:originalRepresentation | 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:orderReferral, Composition.section:originalRepresentation | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| 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 CHCoreComposition
Summary
Mandatory: 10 elements (7 nested mandatory elements)
Must-Support: 35 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CHCoreComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH ORF Composition | |
| text | S | 1..1 | Narrative | Narrative text of the composition |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| dataEnterer | S | 0..1 | (Complex) | The person/organization who has typed/filled in the form content URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer |
| urgentNoficationContactForThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactforthisdocument |
| urgentNoficationContactForTheResponseToThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters about the response URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactfortheresponsetothisdocument |
| receiver | S | 0..1 | Reference(CH Core PractitionerRole) | Person/organization who receives the document URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-receiver |
| copyReceiver | S | 0..* | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Person/organization who receives the copy of this order (shall receive also all results therefrom) URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-copyreceiver |
| precedentDocument | S | 0..1 | Identifier | Identifier of the document which precedes this document in a thread. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-precedentdocument |
| antecedentEpisodeOfCare | S | 0..1 | Reference(CH ORF Episode of Care) | Documentation of the antecedent episode of care e.g hospitalisation in case of care transfer between instituitons e.g. hospitals, rehab. clinics, retirement homes etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-antecedentepisodeofcare |
| initiator | S | 0..1 | (Complex) | Profile to specify who intiated this order; in particulars for spitex and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-initiator |
| patientConsent | S | 0..1 | Reference(CH ORF Consent) | To specify if the patient gave an informed consent to this order; in particulars for spitex
and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-patientconsent |
| status | S | 1..1 | code | preliminary | final | amended | entered-in-error |
| type | S | 1..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) |
| category | S | 1..1 | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) |
| subject | S | 1..1 | Reference(CH Core Patient) | Patient as the principle target of a particular form content |
| author | S | 1..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content |
| title | S | 1..1 | string | Meaningful title |
| Slices for section | S | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code |
| section:orderReferral | S | 1..1 | BackboneElement | Contains the data that supports the order and referral by form. |
| title | S | 1..1 | string | Order-Referral |
| code | S | 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: 93037-0 | |
| text | S | 0..1 | Narrative | Text summary of the section, for human interpretation |
| Slices for entry | S | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:Questionnaire | S | 0..1 | Reference(CH ORF Questionnaire) | Questionnaire |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:QuestionnaireResponse | S | 0..1 | Reference(CH ORF QuestionnaireResponse) | QuestionnaireResponse |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:ServiceRequest | S | 1..* | Reference(CH ORF ServiceRequest) | ServiceRequest |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:DocumentReference | S | 0..* | Reference(CH ORF DocumentReference) | DocumentReference |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| section | 0..0 | |||
| section:originalRepresentation | S | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. |
| title | S | 1..1 | string | Original representation |
| code | S | 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: 55108-5 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Clinical presentation Document | |
| text | S | 1..1 | Narrative | Representation of the original view |
| entry | S | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. |
| section | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Composition.type | preferred | DocumentEntryTypeCode |
| Composition.category | preferred | DocumentEntryClassCode |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH ORF Composition | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text | S | 1..1 | Narrative | Narrative text of the composition |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| dataEnterer | S | 0..1 | (Complex) | The person/organization who has typed/filled in the form content URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer |
| urgentNoficationContactForThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactforthisdocument |
| urgentNoficationContactForTheResponseToThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters about the response URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactfortheresponsetothisdocument |
| receiver | S | 0..1 | Reference(CH Core PractitionerRole) | Person/organization who receives the document URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-receiver |
| copyReceiver | S | 0..* | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Person/organization who receives the copy of this order (shall receive also all results therefrom) URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-copyreceiver |
| precedentDocument | S | 0..1 | Identifier | Identifier of the document which precedes this document in a thread. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-precedentdocument |
| antecedentEpisodeOfCare | S | 0..1 | Reference(CH ORF Episode of Care) | Documentation of the antecedent episode of care e.g hospitalisation in case of care transfer between instituitons e.g. hospitals, rehab. clinics, retirement homes etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-antecedentepisodeofcare |
| initiator | S | 0..1 | (Complex) | Profile to specify who intiated this order; in particulars for spitex and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-initiator |
| patientConsent | S | 0..1 | Reference(CH ORF Consent) | To specify if the patient gave an informed consent to this order; in particulars for spitex
and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-patientconsent |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type | SΣ | 1..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) |
| category | SΣ | 1..1 | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) |
| subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient as the principle target of a particular form content |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | SΣ | 1..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| title | SΣ | 1..1 | string | Meaningful title |
| Slices for section | SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code |
| section:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| section:orderReferral | SC | 1..1 | BackboneElement | Contains the data that supports the order and referral by form. |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | S | 1..1 | string | Order-Referral |
| code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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: 93037-0 | |
| text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
| Slices for entry | SC | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() |
| entry:Questionnaire | SC | 0..1 | Reference(CH ORF Questionnaire) | Questionnaire |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:QuestionnaireResponse | SC | 0..1 | Reference(CH ORF QuestionnaireResponse) | QuestionnaireResponse |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:ServiceRequest | SC | 1..* | Reference(CH ORF ServiceRequest) | ServiceRequest |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| entry:DocumentReference | SC | 0..* | Reference(CH ORF DocumentReference) | DocumentReference |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| section:originalRepresentation | SC | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title | S | 1..1 | string | Original representation |
| code | S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. 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: 55108-5 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Clinical presentation Document | |
| text | SC | 1..1 | Narrative | Representation of the original view |
| entry | SC | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | DocumentEntryTypeCode |
| Composition.category | preferred | DocumentEntryClassCode |
| Composition.section:orderReferral.code | example | Pattern: LOINC code 93037-0 |
| Composition.section:originalRepresentation.code | example | Pattern: LOINC code 55108-5("Clinical presentation Document") |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:orderReferral, Composition.section:originalRepresentation | 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:orderReferral, Composition.section:originalRepresentation | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | CHCoreComposition | CH ORF Composition | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | S | 1..1 | Narrative | Narrative text of the composition | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dataEnterer | S | 0..1 | (Complex) | The person/organization who has typed/filled in the form content URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epr-dataenterer | ||||
| urgentNoficationContactForThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactforthisdocument | ||||
| urgentNoficationContactForTheResponseToThisDocument | S | 0..1 | Reference(CH Core PractitionerRole) | An information recipient to notify for urgent matters about the response URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-urgentnoficationcontactfortheresponsetothisdocument | ||||
| receiver | S | 0..1 | Reference(CH Core PractitionerRole) | Person/organization who receives the document URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-receiver | ||||
| copyReceiver | S | 0..* | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Person/organization who receives the copy of this order (shall receive also all results therefrom) URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-copyreceiver | ||||
| precedentDocument | S | 0..1 | Identifier | Identifier of the document which precedes this document in a thread. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-precedentdocument | ||||
| antecedentEpisodeOfCare | S | 0..1 | Reference(CH ORF Episode of Care) | Documentation of the antecedent episode of care e.g hospitalisation in case of care transfer between instituitons e.g. hospitals, rehab. clinics, retirement homes etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-antecedentepisodeofcare | ||||
| initiator | S | 0..1 | (Complex) | Profile to specify who intiated this order; in particulars for spitex and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-initiator | ||||
| patientConsent | S | 0..1 | Reference(CH ORF Consent) | To specify if the patient gave an informed consent to this order; in particulars for spitex
and transfer to retirement home etc. URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-patientconsent | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| status | ?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | SΣ | 1..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) | ||||
| category | SΣ | 1..1 | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) | ||||
| subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient as the principle target of a particular form content | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter | Σ | 0..1 | Reference(CH Core Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | SΣ | 1..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| title | SΣ | 1..1 | string | Meaningful title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(CH Core Patient | RelatedPerson | CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Who attested the composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| custodian | Σ | 0..1 | Reference(CH Core Organization) | Organization which maintains the composition | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| 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(CH Core 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 | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by pattern:code | ||||
| 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(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core 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 | ||||
| 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:orderReferral | SC | 1..1 | BackboneElement | Contains the data that supports the order and referral by form. | ||||
| 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 | Order-Referral | ||||
| code | S | 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: 93037-0 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| author | 0..* | Reference(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | SC | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| Slices for entry | SC | 1..* | Reference(Resource) | A reference to data that supports this section Slice: Unordered, Open by profile:resolve() | ||||
| entry:Questionnaire | SC | 0..1 | Reference(CH ORF Questionnaire) | Questionnaire | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| entry:QuestionnaireResponse | SC | 0..1 | Reference(CH ORF QuestionnaireResponse) | QuestionnaireResponse | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| entry:ServiceRequest | SC | 1..* | Reference(CH ORF ServiceRequest) | ServiceRequest | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| entry:DocumentReference | SC | 0..* | Reference(CH ORF DocumentReference) | DocumentReference | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section:originalRepresentation | SC | 0..1 | BackboneElement | Contains the original representation as a PDF of the current document. | ||||
| 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 | Original representation | ||||
| code | S | 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: 55108-5 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Clinical presentation Document | |||||
| 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(CH Core Practitioner | CH Core PractitionerRole | Device | CH Core Patient | RelatedPerson | CH Core Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | SC | 1..1 | Narrative | Representation of the original view | ||||
| 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 | 1..1 | Reference(Binary) | According to the EPR ordonnance the PDF has to be in PDF/A-1 or PDF/A-2 format. | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | preferred | DocumentEntryTypeCode | ||||
| Composition.category | preferred | DocumentEntryClassCode | ||||
| Composition.subject.type | extensible | ResourceType | ||||
| Composition.author.type | extensible | ResourceType | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.attester.party.type | extensible | ResourceType | ||||
| Composition.custodian.type | extensible | ResourceType | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | ListMode | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:orderReferral.code | example | Pattern: LOINC code 93037-0 | ||||
| Composition.section:orderReferral.mode | required | ListMode | ||||
| Composition.section:orderReferral.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:orderReferral.entry:Questionnaire.type | extensible | ResourceType | ||||
| Composition.section:orderReferral.entry:QuestionnaireResponse.type | extensible | ResourceType | ||||
| Composition.section:orderReferral.entry:ServiceRequest.type | extensible | ResourceType | ||||
| Composition.section:orderReferral.entry:DocumentReference.type | extensible | ResourceType | ||||
| Composition.section:orderReferral.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:originalRepresentation.code | example | Pattern: LOINC code 55108-5("Clinical presentation Document") | ||||
| Composition.section:originalRepresentation.mode | required | ListMode | ||||
| Composition.section:originalRepresentation.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:originalRepresentation.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:orderReferral, Composition.section:originalRepresentation | 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:orderReferral, Composition.section:originalRepresentation | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| 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 CHCoreComposition
Summary
Mandatory: 10 elements (7 nested mandatory elements)
Must-Support: 35 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 Switzerland. Package ch.fhir.ig.ch-orf#2.0.0-ballot based on FHIR 4.0.1. Generated 2023-06-29
Links: Table of Contents |
QA Report
| Propose a change