Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

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

The official 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 Fri, Thu, Jan 31, 2014 00:00+1100 1, 1970 00:00+1000 as a draft by Health Level Seven, Inc. - Clinical Quality Information WG. HL7.

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

This structure is derived from Composition .

Summary

Mandatory: 4 elements (+1 nested mandatory element)
Fixed Value: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

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

Name Flags Card. Type Description & Constraints doco
. . Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
. . cqm-ValidityPeriod . 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: CatalogType Catalog Type ( example ) ): The type of catalog.

. . . date:IssueDate 1..1 dateTime When the Catalog was created
. . . section 0..* BackboneElement entry 1..* Reference ( CatalogEntry ) Composition is broken into sections The Content of the section

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.

I I I I I Σ I I I I I I I id 0..1 string Unique id for inter-element referencing extension I 0..* Extension Additional content defined by implementations I code Σ I 0..* CodeableConcept Code(s) that apply to the event being documented Binding: ActCode ( example ) I I I I I I 1..* The Content of the I Unknown reference to #Composition.section
Name Flags Card. Type Description & Constraints doco
. . Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language 0..1 code Language of the resource content
Binding: Common All Languages ( preferred required ) ): IETF language tag for a human language
Max Binding: All Languages
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
. . cqm-ValidityPeriod . ValidityPeriod 1..1 dateTime The validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
. . . modifierExtension ?! I Σ 0..* Extension Extensions that cannot be ignored
. . identifier . url Σ I 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 of a variation of the content in the Composition
. . . status ?! Σ I 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus Composition Status ( required ) ): The workflow/clinical status of the composition.

. . . type Σ I 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 Σ I 1..1 CodeableConcept The Content of the section
Binding: CatalogType Catalog Type ( example ) ): The type of catalog.


. . . encounter Σ I 0..1 Reference ( Encounter ) Context of the Composition
. . . date:IssueDate Σ I 1..1 dateTime When the Catalog was created
. . author . useContext Σ I 0..* 1..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference ( Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization ) Who and/or what authored the composition
. . . name Σ 0..1 string Name for this Composition (computer friendly)
. . . title Σ I 1..1 string Human Readable name/title
. . confidentiality . note 0..1 0..* code Annotation As defined by affinity domain For any additional notes
Binding: ConfidentialityClassification ( required )
. . . attester 0..* BackboneElement Attests to accuracy of composition
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . mode 1..1 code CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode Composition Attestation Mode ( required 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 ) Who attested the composition
. . . custodian Σ I 0..1 Reference ( Organization ) Organization which maintains the composition
. . . relatesTo 0..* BackboneElement RelatedArtifact Relationships to other compositions/documents
. . modifierExtension . event ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized code I 1..1 code replaces | transforms | signs | appends Binding: DocumentRelationshipType ( required ) target[x] I 1..1 Target of the relationship targetIdentifier Identifier targetReference Reference (composition.html) event Σ I 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 ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . period Σ I 0..1 Period The period covered by the documentation
. . . . detail Σ I 0..* Reference CodeableReference ( Resource ) The event(s) being documented 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 I 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 ?! Σ I 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 | Device | Patient | RelatedPerson | Organization ) Who and/or what authored the section
. . . . focus 0..1 Reference ( Resource ) Who/what the section is about, when it is not about the subject of composition
. . . . text I C icon 0..1 Narrative Text summary of the section, for human interpretation
. . . mode I 0..1 code working | snapshot | changes Binding: ListMode ( required ) . orderedBy 0..1 CodeableConcept Order of section entries
Binding: List Order Codes ( preferred ) ): What order applies to the items in the entry.

. . . . entry I C icon 0..* Reference ( CatalogEntry Resource ) A reference to data that supports this section
. . . . emptyReason I 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
<!-- Profile for Catalog -->

<!-- ProfileForCatalog -->doco


<Composition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>
 <</meta>
 <
 <
 <

 <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>
 <<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 manageable, 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.

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <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>
 <

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><!-- 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>
 <
 <</type>
 <</category>
 <

 <version value="[string]"/><!-- I 0..1 
     An explicitly assigned identifer of a variation of the content in the Composition -->
 <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><!-- 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>
 <
 <

 <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 1..* Reference(Practitioner) 

     Who and/or what authored the composition --></author>
 <
 <
 <
  <<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 manageable, 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.

 <name value="[string]"/><!-- I 0..1 Name for this Composition (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Human Readable name/title -->
 <note><!-- I 0..* Annotation For any additional notes --></note>
 <attester> I 0..* BackboneElement  <!-- I 0..* Attests to accuracy of composition -->
  <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>
  <
  <
  <

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><!-- 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>
 <
  <<a href="catalog-definitions.html#Composition.relatesTo.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 manageable, 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>
  <
  <
      Target of the relationship</target[x]>
 </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 manageable, 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.

 <relatesTo><!-- I 0..* RelatedArtifact 
     Relationships to other compositions/documents --></relatesTo>
 <event> I 0..* BackboneElement  <!-- I 0..* The clinical service(s) being documented -->
  <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>
  <</code>
  <

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><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <period><!-- I 0..1 Period 

      The period covered by the documentation --></period>
  <
      The event(s) being documented</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 manageable, 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.

 <section> I 0..* BackboneElement  <!-- I 0..* Composition is broken into sections -->
  <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>
  <
  <</code>
  <

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><!-- 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>
  <author><!-- I 0..* Reference(Practitioner) 

      Who and/or what authored the section --></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>
  <
      The Content of the section</entry>
  <</emptyReason>
  <</section>

  <orderedBy><!-- I 0..1 CodeableConcept Order of section entries   --></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 manageable, 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">
    "
    "
    " 
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "

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 identifer of a variation of the content in the Composition
    "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) }], // I R! Who and/or what authored the composition
    "name" : "<string>", // IName for this Composition (computer friendly)
    "title" : "<string>", // I R! Human 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" : [{ RelatedArtifact }], // 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 (+1 nested mandatory element)
Fixed Value: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Differential View

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

Name Flags Card. Type Description & Constraints doco
. . Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
. . cqm-ValidityPeriod . 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: CatalogType Catalog Type ( example ) ): The type of catalog.

. . . date:IssueDate 1..1 dateTime When the Catalog was created
. . . section 0..* BackboneElement entry 1..* Reference ( CatalogEntry ) Composition is broken into sections The Content of the section

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.

I I I I I Σ I I I I I I I id 0..1 string Unique id for inter-element referencing extension I 0..* Extension Additional content defined by implementations I code Σ I 0..* CodeableConcept Code(s) that apply to the event being documented Binding: ActCode ( example ) I I I I I I 1..* The Content of the I Unknown reference to #Composition.section
Name Flags Card. Type Description & Constraints doco
. . Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language 0..1 code Language of the resource content
Binding: Common All Languages ( preferred required ) ): IETF language tag for a human language
Max Binding: All Languages
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
. . cqm-ValidityPeriod . ValidityPeriod 1..1 dateTime The validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
. . . modifierExtension ?! I Σ 0..* Extension Extensions that cannot be ignored
. . identifier . url Σ I 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 of a variation of the content in the Composition
. . . status ?! Σ I 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus Composition Status ( required ) ): The workflow/clinical status of the composition.

. . . type Σ I 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 Σ I 1..1 CodeableConcept The Content of the section
Binding: CatalogType Catalog Type ( example ) ): The type of catalog.


. . . encounter Σ I 0..1 Reference ( Encounter ) Context of the Composition
. . . date:IssueDate Σ I 1..1 dateTime When the Catalog was created
. . author . useContext Σ I 0..* 1..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference ( Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization ) Who and/or what authored the composition
. . . name Σ 0..1 string Name for this Composition (computer friendly)
. . . title Σ I 1..1 string Human Readable name/title
. . confidentiality . note 0..1 0..* code Annotation As defined by affinity domain For any additional notes
Binding: ConfidentialityClassification ( required )
. . . attester 0..* BackboneElement Attests to accuracy of composition
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . mode 1..1 code CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode Composition Attestation Mode ( required 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 ) Who attested the composition
. . . custodian Σ I 0..1 Reference ( Organization ) Organization which maintains the composition
. . . relatesTo 0..* BackboneElement RelatedArtifact Relationships to other compositions/documents
. . modifierExtension . event ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized code I 1..1 code replaces | transforms | signs | appends Binding: DocumentRelationshipType ( required ) target[x] I 1..1 Target of the relationship targetIdentifier Identifier targetReference Reference (composition.html) event Σ I 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 ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . period Σ I 0..1 Period The period covered by the documentation
. . . . detail Σ I 0..* Reference CodeableReference ( Resource ) The event(s) being documented 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 I 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 ?! Σ I 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 | Device | Patient | RelatedPerson | Organization ) Who and/or what authored the section
. . . . focus 0..1 Reference ( Resource ) Who/what the section is about, when it is not about the subject of composition
. . . . text I C icon 0..1 Narrative Text summary of the section, for human interpretation
. . . mode I 0..1 code working | snapshot | changes Binding: ListMode ( required ) . orderedBy 0..1 CodeableConcept Order of section entries
Binding: List Order Codes ( preferred ) ): What order applies to the items in the entry.

. . . . entry I C icon 0..* Reference ( CatalogEntry Resource ) A reference to data that supports this section
. . . . emptyReason I 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

<!-- Profile for Catalog -->

<!-- ProfileForCatalog -->doco


<Composition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>
 <</meta>
 <
 <
 <

 <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>
 <<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 manageable, 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.

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <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>
 <

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><!-- 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>
 <
 <</type>
 <</category>
 <

 <version value="[string]"/><!-- I 0..1 
     An explicitly assigned identifer of a variation of the content in the Composition -->
 <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><!-- 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>
 <
 <

 <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 1..* Reference(Practitioner) 

     Who and/or what authored the composition --></author>
 <
 <
 <
  <<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 manageable, 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.

 <name value="[string]"/><!-- I 0..1 Name for this Composition (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Human Readable name/title -->
 <note><!-- I 0..* Annotation For any additional notes --></note>
 <attester> I 0..* BackboneElement  <!-- I 0..* Attests to accuracy of composition -->
  <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>
  <
  <
  <

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><!-- 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>
 <
  <<a href="catalog-definitions.html#Composition.relatesTo.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 manageable, 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>
  <
  <
      Target of the relationship</target[x]>
 </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 manageable, 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.

 <relatesTo><!-- I 0..* RelatedArtifact 
     Relationships to other compositions/documents --></relatesTo>
 <event> I 0..* BackboneElement  <!-- I 0..* The clinical service(s) being documented -->
  <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>
  <</code>
  <

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><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <period><!-- I 0..1 Period 

      The period covered by the documentation --></period>
  <
      The event(s) being documented</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 manageable, 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.

 <section> I 0..* BackboneElement  <!-- I 0..* Composition is broken into sections -->
  <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>
  <
  <</code>
  <

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><!-- 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>
  <author><!-- I 0..* Reference(Practitioner) 

      Who and/or what authored the section --></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>
  <
      The Content of the section</entry>
  <</emptyReason>
  <</section>

  <orderedBy><!-- I 0..1 CodeableConcept Order of section entries   --></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 manageable, 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">
    "
    "
    " 
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "

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 identifer of a variation of the content in the Composition
    "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) }], // I R! Who and/or what authored the composition
    "name" : "<string>", // IName for this Composition (computer friendly)
    "title" : "<string>", // I R! Human 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" : [{ RelatedArtifact }], // 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 Common All Languages preferred required Common All Languages
Composition.status CompositionStatus Composition Status required CompositionStatus Composition Status
Composition.type FHIR Document Type Codes preferred FHIR Document Type Codes
Composition.category CatalogType Catalog Type example CatalogType Composition.confidentiality V3 Value SetConfidentialityClassification required V3 Value SetConfidentialityClassification Catalog Type
Composition.attester.mode CompositionAttestationMode Composition Attestation Mode required preferred CompositionAttestationMode Composition.relatesTo.code DocumentRelationshipType required DocumentRelationshipType Composition Attestation Mode
Composition.event.code 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.mode ListMode required ListMode Composition.section.orderedBy List Order Codes preferred List Order Codes
Composition.section.emptyReason List Empty Reasons preferred List Empty Reasons
. .