C-CDA on FHIR Implementation Guide STU 1 (v1.0.0)

This page is part of the C-CDA on FHIR Implementation Guide (v1.0.0: STU 1) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: CCDA-on-FHIR-Care-Plan

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Care-Plan

CARE PLAN FRAMEWORK: A Care Plan (including Home Health Plan of Care (HHPoC)) is a consensus-driven dynamic plan that represents a patient and Care Team Members prioritized concerns, goals, and planned interventions. It serves as a blueprint shared by all Care Team Members (including the patient, their caregivers and providers), to guide the patients care. A Care Plan integrates multiple interventions proposed by multiple providers and disciplines for multiple conditions.

A Care Plan represents one or more Plan(s) of Care and serves to reconcile and resolve conflicts between the various Plans of Care developed for a specific patient by different providers. While both a plan of care and a care plan include the patient's life goals and require Care Team Members (including patients) to prioritize goals and interventions, the reconciliation process becomes more complex as the number of plans of care increases. The Care Plan also serves to enable longitudinal coordination of care.

The Care Plan represents an instance of this dynamic Care Plan at a point in time. The composition itself is NOT dynamic.

Key differentiators between a Care Plan profile and CCD profile (another snapshot in time document):

  • Requires relationships between various concepts:

    *  Health Concerns
    
    *  Interventions
    
    *  Goals
    
    *  Outcomes
    
  • Provides the ability to identify patient and provider priorities with each act

  • Provides a header participant to indicate occurrences of Care Plan review

This profile builds on C-CDA on FHIR US Realm Header.

This profile was published on Sat Apr 07 06:53:01 AEST 2018 as a draft by Lantana Consulting Group.

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

This structure is derived from C-CDA on FHIR US Realm Header

Summary

Mandatory: 8 elements (7 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Composition.event.detail is sliced based on the value of profile:reference
  • The element Composition.section is sliced based on the value of value:code
  • The element Composition.section.entry is sliced based on the value of profile:reference

This structure is derived from C-CDA on FHIR US Realm Header

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*
... type 1..1CodeableConceptCare Plan Document
Binding: Care Plan Document Codes (preferred)
... event 0..1BackboneElement
.... period 1..1Period
.... detail Reference(Resource)Slice: Unordered, Open by profile:reference
.... detail 0..*Reference(US Core CarePlan Profile)Care Plan Detail
... section BackboneElementSlice: Unordered, Open by value:code
... section 1..1BackboneElementHealth Concerns Section
.... title 1..1stringtitle
.... code 1..1CodeableConceptHealth concerns section code
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"75310-3"}]}
.... text 1..1Narrativetext
.... entry Reference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry 0..*Reference(US Core AllergyIntolerance Profile | US Core Condition (a.k.a Problem) Profile | US Core Results Profile | US Core Smoking Status Profile | VitalSigns | ClinicalImpression | Observation | RiskAssessment | List | DocumentReference)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
... section 1..1BackboneElementGoals Section
.... title 1..1stringtitle
.... code 1..1CodeableConceptGoals
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"61146-7"}]}
.... text 1..1Narrativetext
.... entry Reference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry 0..*Reference(US Core Goal Profile)entry
... section 0..1BackboneElementInterventions Section
.... title 1..1stringtitle
.... code 1..1CodeableConceptInterventions provided
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"62387-6"}]}
.... text 1..1Narrativetext
.... entry Reference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry 0..*Reference(List | RequestGroup)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
... section 0..1BackboneElementHealth Status Evaluations and Outcomes Section
.... title 1..1stringtitle
.... code 1..1CodeableConceptPatient problem outcome
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"11383-7"}]}
.... text 1..1Narrativetext
.... entry Reference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry 0..*Reference(Observation)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

doco Documentation for this format

This structure is derived from C-CDA on FHIR US Realm Header

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 1..1codelanguage
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... CCDA-on-FHIR-Data-Enterer I0..1Reference(US Core Practitioner Profile)Extension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer"
.... valueReference 0..1Reference(US Core Practitioner Profile)Value of extension
... CCDA-on-FHIR-Informant I0..*Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson)informant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant"
.... valueReference 0..1Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson)Value of extension
... CCDA-on-FHIR-Information-Recipient I0..*Reference(US Core Practitioner Profile)informationRecipient
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient"
.... valueReference 0..1Reference(US Core Practitioner Profile)Value of extension
... CCDA-on-FHIR-Participant I0..*Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson)participant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant"
.... valueReference 0..1Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson)Value of extension
... CCDA-on-FHIR-Performer I0..*Reference(US Core Practitioner Profile)performer
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer"
.... valueReference 0..1Reference(US Core Practitioner Profile)Value of extension
... CCDA-on-FHIR-Authorization I0..*Reference(C-CDA on FHIR Consent)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization"
.... valueReference 0..1Reference(C-CDA on FHIR Consent)Value of extension
... CCDA-on-FHIR-In-Fulfillment-Of-Order I0..*Reference(ProcedureRequest)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order"
.... valueReference 0..1Reference(ProcedureRequest)Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1Identifieridentifier
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type Σ1..1CodeableConceptCare Plan Document
Binding: Care Plan Document Codes (preferred)
... class Σ0..1CodeableConceptCategorization of Composition
Binding: FHIR Document Class Codes (example)
... subject Σ1..1Reference(US Core Patient Profile | Group)Who and/or what the composition is about
... encounter Σ0..1Reference(Encounter)Context of the Composition
... date Σ1..1dateTimedate
... author Σ1..*Reference(US Core Practitioner Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title Σ1..1stringDocument Title
... confidentiality ?!Σ1..1codeconfidentiality
Binding: ConfidentialityClassification (required)
... attester ΣIBackboneElementAttests to accuracy of composition
Slice: Unordered, Open by value:mode
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... mode Σ1..*codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required)
.... time Σ0..1dateTimeWhen the composition was attested
.... party Σ0..1Reference(Patient | Practitioner | Organization)Who attested the composition
... attester ΣI0..1BackboneElementattester
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... mode Σ1..1codemode
Binding: CompositionAttestationMode (required)

Fixed Value: legal
.... time Σ0..1dateTimeWhen the composition was attested
.... party Σ1..1Reference(US Core Practitioner Profile)party
... attester ΣI0..*BackboneElementattester
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... mode Σ1..*codemode
Binding: CompositionAttestationMode (required)

Fixed Value: professional
.... time Σ0..1dateTimeWhen the composition was attested
.... party Σ1..1Reference(US Core Practitioner Profile)party
... attester ΣI0..*BackboneElementattester
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... mode Σ1..*codemode
Binding: CompositionAttestationMode (required)

Fixed Value: personal
.... time Σ0..1dateTimeWhen the composition was attested
.... party Σ1..1Reference(US Core Patient Profile)party
... custodian Σ1..1Reference(US Core Organization Profile)custodian
... relatesTo ΣI0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target[x] Σ1..1Identifier, Reference(Composition)Target of the relationship
... event ΣI0..1BackboneElementThe clinical service(s) being documented
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example)
.... period Σ1..1PeriodThe period covered by the documentation
.... detail ΣReference(Resource)The event(s) being documented
Slice: Unordered, Open by profile:reference
.... detail Σ0..*Reference(US Core CarePlan Profile)Care Plan Detail
... section IBackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: Document Section Codes (example)
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section
Nested Section
... section I1..1BackboneElementHealth Concerns Section
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 1..1stringtitle
.... code 1..1CodeableConceptHealth concerns section code
Binding: Document Section Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"75310-3"}]}
.... text I1..1Narrativetext
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry IReference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry I0..*Reference(US Core AllergyIntolerance Profile | US Core Condition (a.k.a Problem) Profile | US Core Results Profile | US Core Smoking Status Profile | VitalSigns | ClinicalImpression | Observation | RiskAssessment | List | DocumentReference)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section:health_concerns_section
Nested Section
... section I1..1BackboneElementGoals Section
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 1..1stringtitle
.... code 1..1CodeableConceptGoals
Binding: Document Section Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"61146-7"}]}
.... text I1..1Narrativetext
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry IReference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry I0..*Reference(US Core Goal Profile)entry
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section:goals_section
Nested Section
... section I0..1BackboneElementInterventions Section
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 1..1stringtitle
.... code 1..1CodeableConceptInterventions provided
Binding: Document Section Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"62387-6"}]}
.... text I1..1Narrativetext
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry IReference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry I0..*Reference(List | RequestGroup)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section:interventions_section
Nested Section
... section I0..1BackboneElementHealth Status Evaluations and Outcomes Section
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 1..1stringtitle
.... code 1..1CodeableConceptPatient problem outcome
Binding: Document Section Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"11383-7"}]}
.... text I1..1Narrativetext
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry IReference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry I0..*Reference(Observation)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section:eval_outcomes_section
Nested Section

doco Documentation for this format

This structure is derived from C-CDA on FHIR US Realm Header

Summary

Mandatory: 8 elements (7 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Composition.event.detail is sliced based on the value of profile:reference
  • The element Composition.section is sliced based on the value of value:code
  • The element Composition.section.entry is sliced based on the value of profile:reference

Differential View

This structure is derived from C-CDA on FHIR US Realm Header

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*
... type 1..1CodeableConceptCare Plan Document
Binding: Care Plan Document Codes (preferred)
... event 0..1BackboneElement
.... period 1..1Period
.... detail Reference(Resource)Slice: Unordered, Open by profile:reference
.... detail 0..*Reference(US Core CarePlan Profile)Care Plan Detail
... section BackboneElementSlice: Unordered, Open by value:code
... section 1..1BackboneElementHealth Concerns Section
.... title 1..1stringtitle
.... code 1..1CodeableConceptHealth concerns section code
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"75310-3"}]}
.... text 1..1Narrativetext
.... entry Reference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry 0..*Reference(US Core AllergyIntolerance Profile | US Core Condition (a.k.a Problem) Profile | US Core Results Profile | US Core Smoking Status Profile | VitalSigns | ClinicalImpression | Observation | RiskAssessment | List | DocumentReference)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
... section 1..1BackboneElementGoals Section
.... title 1..1stringtitle
.... code 1..1CodeableConceptGoals
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"61146-7"}]}
.... text 1..1Narrativetext
.... entry Reference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry 0..*Reference(US Core Goal Profile)entry
... section 0..1BackboneElementInterventions Section
.... title 1..1stringtitle
.... code 1..1CodeableConceptInterventions provided
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"62387-6"}]}
.... text 1..1Narrativetext
.... entry Reference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry 0..*Reference(List | RequestGroup)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
... section 0..1BackboneElementHealth Status Evaluations and Outcomes Section
.... title 1..1stringtitle
.... code 1..1CodeableConceptPatient problem outcome
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"11383-7"}]}
.... text 1..1Narrativetext
.... entry Reference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry 0..*Reference(Observation)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 1..1codelanguage
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... CCDA-on-FHIR-Data-Enterer I0..1Reference(US Core Practitioner Profile)Extension
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Data-Enterer"
.... valueReference 0..1Reference(US Core Practitioner Profile)Value of extension
... CCDA-on-FHIR-Informant I0..*Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson)informant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Informant"
.... valueReference 0..1Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson)Value of extension
... CCDA-on-FHIR-Information-Recipient I0..*Reference(US Core Practitioner Profile)informationRecipient
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Information-Recipient"
.... valueReference 0..1Reference(US Core Practitioner Profile)Value of extension
... CCDA-on-FHIR-Participant I0..*Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson)participant
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Participant"
.... valueReference 0..1Reference(US Core Practitioner Profile | US Core Patient Profile | RelatedPerson)Value of extension
... CCDA-on-FHIR-Performer I0..*Reference(US Core Practitioner Profile)performer
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Performer"
.... valueReference 0..1Reference(US Core Practitioner Profile)Value of extension
... CCDA-on-FHIR-Authorization I0..*Reference(C-CDA on FHIR Consent)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-Authorization"
.... valueReference 0..1Reference(C-CDA on FHIR Consent)Value of extension
... CCDA-on-FHIR-In-Fulfillment-Of-Order I0..*Reference(ProcedureRequest)authorization
URL: http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/ccda/StructureDefinition/CCDA-on-FHIR-In-Fulfillment-Of-Order"
.... valueReference 0..1Reference(ProcedureRequest)Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1Identifieridentifier
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type Σ1..1CodeableConceptCare Plan Document
Binding: Care Plan Document Codes (preferred)
... class Σ0..1CodeableConceptCategorization of Composition
Binding: FHIR Document Class Codes (example)
... subject Σ1..1Reference(US Core Patient Profile | Group)Who and/or what the composition is about
... encounter Σ0..1Reference(Encounter)Context of the Composition
... date Σ1..1dateTimedate
... author Σ1..*Reference(US Core Practitioner Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title Σ1..1stringDocument Title
... confidentiality ?!Σ1..1codeconfidentiality
Binding: ConfidentialityClassification (required)
... attester ΣIBackboneElementAttests to accuracy of composition
Slice: Unordered, Open by value:mode
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... mode Σ1..*codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required)
.... time Σ0..1dateTimeWhen the composition was attested
.... party Σ0..1Reference(Patient | Practitioner | Organization)Who attested the composition
... attester ΣI0..1BackboneElementattester
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... mode Σ1..1codemode
Binding: CompositionAttestationMode (required)

Fixed Value: legal
.... time Σ0..1dateTimeWhen the composition was attested
.... party Σ1..1Reference(US Core Practitioner Profile)party
... attester ΣI0..*BackboneElementattester
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... mode Σ1..*codemode
Binding: CompositionAttestationMode (required)

Fixed Value: professional
.... time Σ0..1dateTimeWhen the composition was attested
.... party Σ1..1Reference(US Core Practitioner Profile)party
... attester ΣI0..*BackboneElementattester
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... mode Σ1..*codemode
Binding: CompositionAttestationMode (required)

Fixed Value: personal
.... time Σ0..1dateTimeWhen the composition was attested
.... party Σ1..1Reference(US Core Patient Profile)party
... custodian Σ1..1Reference(US Core Organization Profile)custodian
... relatesTo ΣI0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target[x] Σ1..1Identifier, Reference(Composition)Target of the relationship
... event ΣI0..1BackboneElementThe clinical service(s) being documented
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example)
.... period Σ1..1PeriodThe period covered by the documentation
.... detail ΣReference(Resource)The event(s) being documented
Slice: Unordered, Open by profile:reference
.... detail Σ0..*Reference(US Core CarePlan Profile)Care Plan Detail
... section IBackboneElementComposition is broken into sections
Slice: Unordered, Open by value:code
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: Document Section Codes (example)
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section
Nested Section
... section I1..1BackboneElementHealth Concerns Section
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 1..1stringtitle
.... code 1..1CodeableConceptHealth concerns section code
Binding: Document Section Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"75310-3"}]}
.... text I1..1Narrativetext
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry IReference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry I0..*Reference(US Core AllergyIntolerance Profile | US Core Condition (a.k.a Problem) Profile | US Core Results Profile | US Core Smoking Status Profile | VitalSigns | ClinicalImpression | Observation | RiskAssessment | List | DocumentReference)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section:health_concerns_section
Nested Section
... section I1..1BackboneElementGoals Section
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 1..1stringtitle
.... code 1..1CodeableConceptGoals
Binding: Document Section Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"61146-7"}]}
.... text I1..1Narrativetext
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry IReference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry I0..*Reference(US Core Goal Profile)entry
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section:goals_section
Nested Section
... section I0..1BackboneElementInterventions Section
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 1..1stringtitle
.... code 1..1CodeableConceptInterventions provided
Binding: Document Section Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"62387-6"}]}
.... text I1..1Narrativetext
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry IReference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry I0..*Reference(List | RequestGroup)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section:interventions_section
Nested Section
... section I0..1BackboneElementHealth Status Evaluations and Outcomes Section
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... title 1..1stringtitle
.... code 1..1CodeableConceptPatient problem outcome
Binding: Document Section Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"11383-7"}]}
.... text I1..1Narrativetext
.... mode ?!Σ0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry IReference(Resource)entry
Slice: Unordered, Open by profile:reference
.... entry I0..*Reference(Observation)This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section:eval_outcomes_section
Nested Section

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Composition.languageCommon LanguagesextensibleCommon Languages
Composition.statusCompositionStatusrequiredCompositionStatus
Composition.typeCare Plan Document CodespreferredCare Plan Document Codes
Composition.classFHIR Document Class CodesexampleFHIR Document Class Codes
Composition.confidentialityConfidentialityClassificationrequiredConfidentialityClassification
Composition.attester.modeCompositionAttestationModerequiredCompositionAttestationMode
Composition.attester.modeCompositionAttestationModerequiredCompositionAttestationMode
Composition.attester.modeCompositionAttestationModerequiredCompositionAttestationMode
Composition.attester.modeCompositionAttestationModerequiredCompositionAttestationMode
Composition.relatesTo.codeDocumentRelationshipTyperequiredDocumentRelationshipType
Composition.event.codev3 Code System ActCodeexamplev3 Code System ActCode
Composition.section.codeDocument Section CodesexampleDocument Section Codes
Composition.section.modeListModerequiredListMode
Composition.section.orderedByList Order CodespreferredList Order Codes
Composition.section.emptyReasonList Empty ReasonspreferredList Empty Reasons
Composition.section.codeDocument Section CodesexampleDocument Section Codes
Composition.section.modeListModerequiredListMode
Composition.section.orderedByList Order CodespreferredList Order Codes
Composition.section.emptyReasonList Empty ReasonspreferredList Empty Reasons
Composition.section.codeDocument Section CodesexampleDocument Section Codes
Composition.section.modeListModerequiredListMode
Composition.section.orderedByList Order CodespreferredList Order Codes
Composition.section.emptyReasonList Empty ReasonspreferredList Empty Reasons
Composition.section.codeDocument Section CodesexampleDocument Section Codes
Composition.section.modeListModerequiredListMode
Composition.section.orderedByList Order CodespreferredList Order Codes
Composition.section.emptyReasonList Empty ReasonspreferredList Empty Reasons
Composition.section.codeDocument Section CodesexampleDocument Section Codes
Composition.section.modeListModerequiredListMode
Composition.section.orderedByList Order CodespreferredList Order Codes
Composition.section.emptyReasonList Empty ReasonspreferredList Empty Reasons

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1CompositionIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4CompositionIf 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-3CompositionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1Composition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Composition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Composition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Composition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Composition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Composition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Composition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Composition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Composition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Composition.attesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Composition.attesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Composition.attesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Composition.attesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Composition.relatesToAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Composition.eventAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Composition.sectionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
cmp-1Composition.sectionA section must at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
ele-1Composition.sectionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
cmp-1Composition.sectionA section must at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
ele-1Composition.sectionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
cmp-1Composition.sectionA section must at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
ele-1Composition.sectionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
cmp-1Composition.sectionA section must at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
ele-1Composition.sectionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
cmp-1Composition.sectionA section must at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
.