Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B R4

  Maturity Level : 0
Structured Documents icon Work Group Trial Use Normative Use Context : Any

The canonical URL for this profile is:

http://hl7.org/fhir/StructureDefinition/catalog

A set of resources composed into a single coherent clinical statement with clinical attestation

This profile was published on Thu, Jan 1, 1970 00:00+1000 00:00+0000 as a draft by HL7.

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

This structure is derived from Composition .

Summary

Mandatory: 4 elements
Fixed Value: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

This indicates the differences between this profile and the base Composition structure.

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
. . ValidityPeriod . Slices for extension 1..1 Content/Rules for all slices
.... extension:ValidityPeriod 1..1 dateTime The validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
. . . type 1..1 CodeableConcept The type of document - a Catalog
Fixed Value: As shown
. . . . text 1..1 string Plain text representation of the concept
Fixed Value: Catalog
. . . category 1..1 CodeableConcept The Content of the section
Binding: Catalog Type ( example ): ) : The type of catalog.
. . . subject 0 .. 0 Who and/or what the composition is about
. . date:IssueDate . date 1..1 dateTime When the Catalog was created
. . . section 0..* BackboneElement Composition is broken into sections

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Composition structure.

1..* 1..1
Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
. . . 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: All Languages ( required ): ) : IETF language tag for a human language
Additional Bindings Purpose
Common Languages Starter
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension 0..* 1..* Extension Extension
Slice: Unordered, Open by value:url
. . . . ValidityPeriod extension:ValidityPeriod 1..1 dateTime The validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . . url Σ 0..1 uri Canonical identifier for this Composition, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Version-independent identifier for the Composition
. . . version Σ 0..1 string An explicitly assigned identifer identifier of a variation of the content in the Composition
. . . consent 0..* Reference ( Consent ) Represents informed consents and medico-legal transactions
... basedOn 0..* Reference ( Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | Task | VisionPrescription ) Fulfills plan, proposal or order
. . . status ?! Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: Composition Status ( required ): ) : The workflow/clinical workflow status of the composition.
. . . type Σ 1..1 CodeableConcept The type of document - a Catalog
Binding: FHIR Document Type Codes ( preferred ): ) : Type of a composition.
Fixed Value: As shown
. . . . id 0..0 string Unique id for inter-element referencing
. . . . extension 0..0 Extension Additional content defined by implementations
. . . . coding 0..0 Coding Code defined by a terminology system
. . . . text 1..1 string Plain text representation of the concept
Fixed Value: Catalog
. . . category Σ 1..1 CodeableConcept The Content of the section
Binding: Catalog Type ( example ): ) : The type of catalog.
. . . encounter Σ 0..1 Reference ( Encounter ) Context of the Composition
. . date:IssueDate . date Σ 1..1 dateTime When the Catalog was created
. . . useContext Σ 0..* UsageContext The context that the content is intended to support
. . . author Σ 0..* Reference ( Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization ) Who and/or what authored the composition
. . name . participant 0..* BackboneElement Identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient
.... 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
.... type 1..* CodeableConcept AUT | AUTHEN | CST | LA | RCT | SBJ
Binding: FHIR Clinical Document Participant Types Value set icon ( preferred ) : FHIR Clinical Document Participant Types. Author, Authenticator, Custodian, Legal Authenticator, Record Target and Subject are found in distinct, named fields in FHIR. Thus, these types are excluded.
.... function 0..* CodeableConcept Binding: ParticipationFunction icon ( preferred ) : To specify the exact function an actor had in a service in all necessary detail.
.... time 0..1 Period Time period of participation
.... party 1..1 Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization ) Who the participant is
... name Σ 0..1 string Name for this Composition (computer friendly)
. . . title Σ 0..1 string Human Readable name/title
. . . note 0..* Annotation For any additional notes
. . . attester C icon 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 CodeableConcept personal | professional | legal | official
Binding: Composition Attestation Mode ( preferred ): ) : The way in which a person authenticated a composition.
. . . . time 0..1 dateTime When the composition was attested
. . . . party 0..1 Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | Group ) Who attested the composition
. . . custodian Σ 0..1 Reference ( Organization | Patient | Group ) Organization which maintains the composition
. . . relatesTo 0..* RelatedArtifact 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
.... type 1..1 CodeableConcept documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Binding: Artifact Relationship Type icon ( extensible ) : The type of relationship to the related artifact.
.... target[x] 1..1 The artifact that is related to this Composition
..... targetUri uri
.... . targetAttachment Attachment
..... targetCanonical canonical ( Resource )
..... targetReference Reference ( Resource )
..... targetMarkdown markdown
... 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
. . . . period Σ 0..1 Period The period covered by the documentation
. . . . detail Σ 0..* CodeableReference ( Resource ) The event(s) being documented, as code(s), reference(s), or both
Binding: v3 Code System ActCode icon ( example ): ) : This list of codes represents the main clinical acts being documented.
. . . section C icon 0..* BackboneElement Composition is broken into sections
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . title 0..1 string Label for section (e.g. for ToC)
. . . . code 0..1 CodeableConcept Classification of section (recommended)
Binding: Document Section Codes ( example ): ) : Classification of a section of a composition/document.
. . . . author 0..* Reference ( Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization ) Who and/or what authored the section, when the section is authored by someone other than the composition.author
. . . . focus 0..1 Reference ( Resource ) Who/what the section is about, when it is not about the subject of composition
. . . . text C icon 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
. . . . note 0..* Annotation Information about the section contents that is not represented by any of the section entries
.... orderedBy 0..1 CodeableConcept Order of section entries
Binding: List Order Codes icon ( preferred ): ) : What order applies to the items in the entry.
. . . . entry C icon 0..* Reference ( Resource ) A reference to data that supports this section
. . . . emptyReason C icon 0..1 CodeableConcept Why the section is empty
Binding: List Empty Reasons ( preferred ): ) : If a section is empty, why it is empty.
. . . . section 0..* See section (Composition) Nested Section

doco Documentation for this format icon
<!-- ProfileForCatalog -->doco

<Composition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <

 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->

 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <<a href="catalog-definitions.html#Composition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>

 <url value="[uri]"/><!-- I 0..1 Canonical identifier for this Composition, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier 
     Version-independent identifier for the Composition --></identifier>
 <
     An explicitly assigned identifer of a variation of the content in the Composition

 <version value="[string]"/><!-- I 0..1 
     An explicitly assigned identifier of a variation of the content in the Composition -->
 <consent><!-- I 0..* Reference(Consent) 
     Represents informed consents and medico-legal transactions --></consent>
 <basedOn><!-- I 0..* Reference(Appointment) Fulfills plan, proposal or order --></basedOn>

 <status value="[code]"/><!-- I 1..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown   -->
 <type><!-- I 1..1 CodeableConcept The type of document - a Catalog   --></type>
 <</category>

 <category><!-- I 1..1 CodeableConcept The Content of the section   --></category>

 <subject><!-- I 0..0 Reference(Resource) 
     Who and/or what the composition is about --></subject>
 <encounter><!-- I 0..1 Reference(Encounter) Context of the Composition --></encounter>
 <date value="[dateTime]"/><!-- I 1..1 When the Catalog was created -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <

 <author><!-- I 0..* Reference(Practitioner) 

     Who and/or what authored the composition --></author>
 <participant> I 0..* BackboneElement  <!-- I 0..* Identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- I 1..* CodeableConcept AUT | AUTHEN | CST | LA | RCT | SBJ icon   --></type>
  <function><!-- I 0..* CodeableConcept  icon   --></function>
  <time><!-- I 0..1 Period 
      Time period of participation --></time>
  <party><!-- I 1..1 Reference(Practitioner) 
      Who the participant is --></party>
 </participant>

 <name value="[string]"/><!-- I 0..1 Name for this Composition (computer friendly) -->
 <

 <title value="[string]"/><!-- I 0..1 Human Readable name/title -->

 <note><!-- I 0..* Annotation For any additional notes --></note>
 <
  <<a href="catalog-definitions.html#Composition.attester.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <attester> I 0..* BackboneElement  <!-- I 0..* Attests to accuracy of composition -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>

  <mode><!-- I 1..1 CodeableConcept personal | professional | legal | official   --></mode>
  <time value="[dateTime]"/><!-- I 0..1 When the composition was attested -->
  <party><!-- I 0..1 Reference(Patient) 
      Who attested the composition --></party>
 </attester>
 <custodian><!-- I 0..1 Reference(Organization) 
     Organization which maintains the composition --></custodian>
 <
     Relationships to other compositions/documents</relatesTo>
 <
  <<a href="catalog-definitions.html#Composition.event.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <relatesTo> I 0..* BackboneElement  <!-- I 0..* Relationships to other compositions/documents -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- I 1..1 CodeableConcept documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes icon   --></type>
  <target[x]><!-- I 1..1 uri|Attachment|canonical|Reference(Resource)|
    markdown The artifact that is related to this Composition --></target[x]>

 </relatesTo>
 <event> I 0..* BackboneElement  <!-- I 0..* The clinical service(s) being documented -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>

  <period><!-- I 0..1 Period 
      The period covered by the documentation --></period>
  <</detail>

  <detail><!-- I 0..* CodeableReference The event(s) being documented, as code(s), reference(s), or both icon   --></detail>

 </event>
 <
  <<a href="catalog-definitions.html#Composition.section.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <section> I 0..* BackboneElement  <!-- I 0..* Composition is broken into sections -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>

  <title value="[string]"/><!-- I 0..1 Label for section (e.g. for ToC) -->
  <code><!-- I 0..1 CodeableConcept Classification of section (recommended)   --></code>
  <
      Who and/or what authored the section</author>

  <author><!-- I 0..* Reference(Practitioner) 
      Who and/or what authored the section, when the section is authored by someone other than the composition.author --></author>

  <focus><!-- I 0..1 Reference(Resource) 
      Who/what the section is about, when it is not about the subject of composition --></focus>
  <text><!-- I 0..1 Narrative 
      Text summary of the section, for human interpretation --></text>
  <</orderedBy>

  <note><!-- I 0..* Annotation 
      Information about the section contents that is not represented by any of the section entries --></note>
  <orderedBy><!-- I 0..1 CodeableConcept Order of section entries icon   --></orderedBy>

  <entry><!-- I 0..* Reference(Resource) 
      A reference to data that supports this section --></entry>
  <emptyReason><!-- I 0..1 CodeableConcept Why the section is empty   --></emptyReason>
  <section><!-- See http://hl7.org/fhir/StructureDefinition/Composition#Composition.section  Nested Section --></section>
 </section>
</Composition>
{ // ProfileForCatalog
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "

    "implicitRules" : "<uri>", // IA set of rules under which this content was created

    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The validity of the catalog // I R! 
        // from Element: extension
      }
    ],
    "<a href="catalog-definitions.html#Composition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">

    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored

    "url" : "<uri>", // ICanonical identifier for this Composition, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IVersion-independent identifier for the Composition
    "

    "version" : "<string>", // IAn explicitly assigned identifier of a variation of the content in the Composition
    "consent" : [{ Reference(Consent) }], // IRepresents informed consents and medico-legal transactions
    "basedOn" : [{ Reference(Appointment) }], // IFulfills plan, proposal or order

    "status" : "<code>", // I R! registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
    "type" : { CodeableConcept }, // I R! 
    "

    "category" : { CodeableConcept }, // I R! The Content of the section

    "encounter" : { Reference(Encounter) }, // IContext of the Composition
    "date" : "<dateTime>", // I R! When the Catalog was created
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "

    "author" : [{ Reference(Practitioner) }], // IWho and/or what authored the composition
    "participant" : [{ BackboneElement }], // IIdentifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient

    "name" : "<string>", // IName for this Composition (computer friendly)
    "

    "title" : "<string>", // IHuman Readable name/title

    "note" : [{ Annotation }], // IFor any additional notes
    "

    "attester" : [{ BackboneElement }], // IAttests to accuracy of composition

    "custodian" : { Reference(Organization) }, // IOrganization which maintains the composition
    "
    "
    "

    "relatesTo" : [{ BackboneElement }], // IRelationships to other compositions/documents
    "event" : [{ BackboneElement }], // IThe clinical service(s) being documented
    "section" : [{ BackboneElement }], // IComposition is broken into sections

  }

This structure is derived from Composition .

Summary

Mandatory: 4 elements
Fixed Value: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Differential View

This indicates the differences between this profile and the base Composition structure.

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
. . ValidityPeriod . Slices for extension 1..1 Content/Rules for all slices
.... extension:ValidityPeriod 1..1 dateTime The validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
. . . type 1..1 CodeableConcept The type of document - a Catalog
Fixed Value: As shown
. . . . text 1..1 string Plain text representation of the concept
Fixed Value: Catalog
. . . category 1..1 CodeableConcept The Content of the section
Binding: Catalog Type ( example ): ) : The type of catalog.
. . . subject 0 .. 0 Who and/or what the composition is about
. . date:IssueDate . date 1..1 dateTime When the Catalog was created
. . . section 0..* BackboneElement Composition is broken into sections

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Composition structure.

1..* 1..1
Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
. . . 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: All Languages ( required ): ) : IETF language tag for a human language
Additional Bindings Purpose
Common Languages Starter
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension 0..* 1..* Extension Extension
Slice: Unordered, Open by value:url
. . . . ValidityPeriod extension:ValidityPeriod 1..1 dateTime The validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . . url Σ 0..1 uri Canonical identifier for this Composition, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Version-independent identifier for the Composition
. . . version Σ 0..1 string An explicitly assigned identifer identifier of a variation of the content in the Composition
. . . consent 0..* Reference ( Consent ) Represents informed consents and medico-legal transactions
... basedOn 0..* Reference ( Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | Task | VisionPrescription ) Fulfills plan, proposal or order
. . . status ?! Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: Composition Status ( required ): ) : The workflow/clinical workflow status of the composition.
. . . type Σ 1..1 CodeableConcept The type of document - a Catalog
Binding: FHIR Document Type Codes ( preferred ): ) : Type of a composition.
Fixed Value: As shown
. . . . id 0..0 string Unique id for inter-element referencing
. . . . extension 0..0 Extension Additional content defined by implementations
. . . . coding 0..0 Coding Code defined by a terminology system
. . . . text 1..1 string Plain text representation of the concept
Fixed Value: Catalog
. . . category Σ 1..1 CodeableConcept The Content of the section
Binding: Catalog Type ( example ): ) : The type of catalog.
. . . encounter Σ 0..1 Reference ( Encounter ) Context of the Composition
. . date:IssueDate . date Σ 1..1 dateTime When the Catalog was created
. . . useContext Σ 0..* UsageContext The context that the content is intended to support
. . . author Σ 0..* Reference ( Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization ) Who and/or what authored the composition
. . name . participant 0..* BackboneElement Identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient
.... 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
.... type 1..* CodeableConcept AUT | AUTHEN | CST | LA | RCT | SBJ
Binding: FHIR Clinical Document Participant Types Value set icon ( preferred ) : FHIR Clinical Document Participant Types. Author, Authenticator, Custodian, Legal Authenticator, Record Target and Subject are found in distinct, named fields in FHIR. Thus, these types are excluded.
.... function 0..* CodeableConcept Binding: ParticipationFunction icon ( preferred ) : To specify the exact function an actor had in a service in all necessary detail.
.... time 0..1 Period Time period of participation
.... party 1..1 Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization ) Who the participant is
... name Σ 0..1 string Name for this Composition (computer friendly)
. . . title Σ 0..1 string Human Readable name/title
. . . note 0..* Annotation For any additional notes
. . . attester C icon 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 CodeableConcept personal | professional | legal | official
Binding: Composition Attestation Mode ( preferred ): ) : The way in which a person authenticated a composition.
. . . . time 0..1 dateTime When the composition was attested
. . . . party 0..1 Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | Group ) Who attested the composition
. . . custodian Σ 0..1 Reference ( Organization | Patient | Group ) Organization which maintains the composition
. . . relatesTo 0..* RelatedArtifact 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
.... type 1..1 CodeableConcept documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Binding: Artifact Relationship Type icon ( extensible ) : The type of relationship to the related artifact.
.... target[x] 1..1 The artifact that is related to this Composition
..... targetUri uri
.... . targetAttachment Attachment
..... targetCanonical canonical ( Resource )
..... targetReference Reference ( Resource )
..... targetMarkdown markdown
... 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
. . . . period Σ 0..1 Period The period covered by the documentation
. . . . detail Σ 0..* CodeableReference ( Resource ) The event(s) being documented, as code(s), reference(s), or both
Binding: v3 Code System ActCode icon ( example ): ) : This list of codes represents the main clinical acts being documented.
. . . section C icon 0..* BackboneElement Composition is broken into sections
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . title 0..1 string Label for section (e.g. for ToC)
. . . . code 0..1 CodeableConcept Classification of section (recommended)
Binding: Document Section Codes ( example ): ) : Classification of a section of a composition/document.
. . . . author 0..* Reference ( Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization ) Who and/or what authored the section, when the section is authored by someone other than the composition.author
. . . . focus 0..1 Reference ( Resource ) Who/what the section is about, when it is not about the subject of composition
. . . . text C icon 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
. . . . note 0..* Annotation Information about the section contents that is not represented by any of the section entries
.... orderedBy 0..1 CodeableConcept Order of section entries
Binding: List Order Codes icon ( preferred ): ) : What order applies to the items in the entry.
. . . . entry C icon 0..* Reference ( Resource ) A reference to data that supports this section
. . . . emptyReason C icon 0..1 CodeableConcept Why the section is empty
Binding: List Empty Reasons ( preferred ): ) : If a section is empty, why it is empty.
. . . . section 0..* See section (Composition) Nested Section

doco Documentation for this format icon

XML Template

<!-- ProfileForCatalog -->doco

<Composition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <

 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->

 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <<a href="catalog-definitions.html#Composition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>

 <url value="[uri]"/><!-- I 0..1 Canonical identifier for this Composition, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier 
     Version-independent identifier for the Composition --></identifier>
 <
     An explicitly assigned identifer of a variation of the content in the Composition

 <version value="[string]"/><!-- I 0..1 
     An explicitly assigned identifier of a variation of the content in the Composition -->
 <consent><!-- I 0..* Reference(Consent) 
     Represents informed consents and medico-legal transactions --></consent>
 <basedOn><!-- I 0..* Reference(Appointment) Fulfills plan, proposal or order --></basedOn>

 <status value="[code]"/><!-- I 1..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown   -->
 <type><!-- I 1..1 CodeableConcept The type of document - a Catalog   --></type>
 <</category>

 <category><!-- I 1..1 CodeableConcept The Content of the section   --></category>

 <subject><!-- I 0..0 Reference(Resource) 
     Who and/or what the composition is about --></subject>
 <encounter><!-- I 0..1 Reference(Encounter) Context of the Composition --></encounter>
 <date value="[dateTime]"/><!-- I 1..1 When the Catalog was created -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <

 <author><!-- I 0..* Reference(Practitioner) 

     Who and/or what authored the composition --></author>
 <participant> I 0..* BackboneElement  <!-- I 0..* Identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- I 1..* CodeableConcept AUT | AUTHEN | CST | LA | RCT | SBJ icon   --></type>
  <function><!-- I 0..* CodeableConcept  icon   --></function>
  <time><!-- I 0..1 Period 
      Time period of participation --></time>
  <party><!-- I 1..1 Reference(Practitioner) 
      Who the participant is --></party>
 </participant>

 <name value="[string]"/><!-- I 0..1 Name for this Composition (computer friendly) -->
 <

 <title value="[string]"/><!-- I 0..1 Human Readable name/title -->

 <note><!-- I 0..* Annotation For any additional notes --></note>
 <
  <<a href="catalog-definitions.html#Composition.attester.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <attester> I 0..* BackboneElement  <!-- I 0..* Attests to accuracy of composition -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>

  <mode><!-- I 1..1 CodeableConcept personal | professional | legal | official   --></mode>
  <time value="[dateTime]"/><!-- I 0..1 When the composition was attested -->
  <party><!-- I 0..1 Reference(Patient) 
      Who attested the composition --></party>
 </attester>
 <custodian><!-- I 0..1 Reference(Organization) 
     Organization which maintains the composition --></custodian>
 <
     Relationships to other compositions/documents</relatesTo>
 <
  <<a href="catalog-definitions.html#Composition.event.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <relatesTo> I 0..* BackboneElement  <!-- I 0..* Relationships to other compositions/documents -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- I 1..1 CodeableConcept documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes icon   --></type>
  <target[x]><!-- I 1..1 uri|Attachment|canonical|Reference(Resource)|
    markdown The artifact that is related to this Composition --></target[x]>

 </relatesTo>
 <event> I 0..* BackboneElement  <!-- I 0..* The clinical service(s) being documented -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>

  <period><!-- I 0..1 Period 
      The period covered by the documentation --></period>
  <</detail>

  <detail><!-- I 0..* CodeableReference The event(s) being documented, as code(s), reference(s), or both icon   --></detail>

 </event>
 <
  <<a href="catalog-definitions.html#Composition.section.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <section> I 0..* BackboneElement  <!-- I 0..* Composition is broken into sections -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>

  <title value="[string]"/><!-- I 0..1 Label for section (e.g. for ToC) -->
  <code><!-- I 0..1 CodeableConcept Classification of section (recommended)   --></code>
  <
      Who and/or what authored the section</author>

  <author><!-- I 0..* Reference(Practitioner) 
      Who and/or what authored the section, when the section is authored by someone other than the composition.author --></author>

  <focus><!-- I 0..1 Reference(Resource) 
      Who/what the section is about, when it is not about the subject of composition --></focus>
  <text><!-- I 0..1 Narrative 
      Text summary of the section, for human interpretation --></text>
  <</orderedBy>

  <note><!-- I 0..* Annotation 
      Information about the section contents that is not represented by any of the section entries --></note>
  <orderedBy><!-- I 0..1 CodeableConcept Order of section entries icon   --></orderedBy>

  <entry><!-- I 0..* Reference(Resource) 
      A reference to data that supports this section --></entry>
  <emptyReason><!-- I 0..1 CodeableConcept Why the section is empty   --></emptyReason>
  <section><!-- See http://hl7.org/fhir/StructureDefinition/Composition#Composition.section  Nested Section --></section>
 </section>
</Composition>

JSON Template

{ // ProfileForCatalog
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "

    "implicitRules" : "<uri>", // IA set of rules under which this content was created

    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The validity of the catalog // I R! 
        // from Element: extension
      }
    ],
    "<a href="catalog-definitions.html#Composition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">

    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored

    "url" : "<uri>", // ICanonical identifier for this Composition, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IVersion-independent identifier for the Composition
    "

    "version" : "<string>", // IAn explicitly assigned identifier of a variation of the content in the Composition
    "consent" : [{ Reference(Consent) }], // IRepresents informed consents and medico-legal transactions
    "basedOn" : [{ Reference(Appointment) }], // IFulfills plan, proposal or order

    "status" : "<code>", // I R! registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
    "type" : { CodeableConcept }, // I R! 
    "

    "category" : { CodeableConcept }, // I R! The Content of the section

    "encounter" : { Reference(Encounter) }, // IContext of the Composition
    "date" : "<dateTime>", // I R! When the Catalog was created
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "

    "author" : [{ Reference(Practitioner) }], // IWho and/or what authored the composition
    "participant" : [{ BackboneElement }], // IIdentifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient

    "name" : "<string>", // IName for this Composition (computer friendly)
    "

    "title" : "<string>", // IHuman Readable name/title

    "note" : [{ Annotation }], // IFor any additional notes
    "

    "attester" : [{ BackboneElement }], // IAttests to accuracy of composition

    "custodian" : { Reference(Organization) }, // IOrganization which maintains the composition
    "
    "
    "

    "relatesTo" : [{ BackboneElement }], // IRelationships to other compositions/documents
    "event" : [{ BackboneElement }], // IThe clinical service(s) being documented
    "section" : [{ BackboneElement }], // IComposition is broken into sections

  }

 

Alternate definitions: Master Definition ( XML , JSON ), Schematron

Path Name Conformance ValueSet
Composition.language All Languages required All Languages
Composition.status Composition Status required Composition Status
Composition.type FHIR Document Type Codes preferred FHIR Document Type Codes
Composition.category Catalog Type example Catalog Type
Composition.attester.mode Composition.participant.type FHIR Clinical Document Participant Types Value set preferred FHIR Clinical Document Participant Types Value set icon
Composition.participant.function ParticipationFunction preferred ParticipationFunction icon
Composition.attester.mode Composition Attestation Mode preferred Composition Attestation Mode
Composition.event.detail Composition.relatesTo.type Artifact Relationship Type extensible Artifact Relationship Type icon
Composition.event.detail v3 Code System ActCode example v3 Code System ActCode icon
Composition.section.code Document Section Codes example Document Section Codes
Composition.section.orderedBy List Order Codes preferred List Order Codes icon
Composition.section.emptyReason List Empty Reasons preferred List Empty Reasons
. .