Current Build
Structured Documents Work Group Maturity Level: 1Trial Use Use Context: Any

The official 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, Jan 31, 2014 00:00+0000 as a draft by Health Level Seven, Inc. - Clinical Quality Information WG.

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 Composition.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*A set of resources composed into a single coherent clinical statement with clinical attestation
... cqm-ValidityPeriod 1..1dateTimeThe validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
... type 1..1CodeableConceptThe type of document - a Catalog
Fixed Value: {"text":"Catalog"}
... category 1..1CodeableConceptThe Content of the section
Binding: CatalogType (example)
... subject 0..0
... date 1..1dateTimeWhen the Catalog was created
... section 0..*BackboneElement
.... entry 1..*Reference(CatalogEntry)The Content of the section

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqm-ValidityPeriod I1..1dateTimeThe validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type Σ1..1CodeableConceptThe type of document - a Catalog
Binding: FHIR Document Type Codes (preferred)
Fixed Value: {"text":"Catalog"}
... category Σ1..1CodeableConceptThe Content of the section
Binding: CatalogType (example)
... encounter Σ0..1Reference(Encounter)Context of the Composition
... date Σ1..1dateTimeWhen the Catalog was created
... author Σ1..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: ConfidentialityClassification (required)
... attester I0..*BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required)
.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
... custodian Σ0..1Reference(Organization)Organization which maintains the composition
... relatesTo I0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target[x] 1..1Identifier, Reference(Composition)Target of the relationship
... event ΣI0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: ActCode (example)
.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section I0..*BackboneElementComposition is broken into sections
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: Document Section Codes (example)
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry I1..*Reference(CatalogEntry)The Content of the section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section
Nested Section

doco Documentation for this format
<!-- Profile for Catalog -->doco

<Composition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content   -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..1 Identifier 
     Version-independent identifier for the Composition --></identifier>
 <status value="[code]"/><!-- 1..1 preliminary | final | amended | entered-in-error   -->
 <type><!-- 1..1 CodeableConcept The type of document - a Catalog   --></type>
 <category><!-- 1..1 CodeableConcept The Content of the section   --></category>
 <subject><!-- 0..0 Reference(Resource) 
     Who and/or what the composition is about --></subject>
 <encounter><!-- 0..1 Reference(Encounter) Context of the Composition --></encounter>
 <date value="[dateTime]"/><!-- 1..1 When the Catalog was created -->
 <author><!-- 1..* Reference(Practitioner) 
     Who and/or what authored the composition --></author>
 <title value="[string]"/><!-- 1..1 Human Readable name/title -->
 <confidentiality value="[code]"/><!-- 0..1 As defined by affinity domain   -->
 <attester> ?? 0..* BackboneElement  <!-- ?? 0..* Attests to accuracy of composition -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <mode value="[code]"/><!-- 1..1 personal | professional | legal | official   -->
  <time value="[dateTime]"/><!-- 0..1 When the composition was attested -->
  <party><!-- 0..1 Reference(Patient) 
      Who attested the composition --></party>
 </attester>
 <custodian><!-- 0..1 Reference(Organization) 
     Organization which maintains the composition --></custodian>
 <relatesTo> ?? 0..* BackboneElement  <!-- ?? 0..* Relationships to other compositions/documents -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- 1..1 replaces | transforms | signs | appends   -->
  <target[x]><!-- 1..1 Identifier|Reference(Composition) 
      Target of the relationship --></target[x]>
 </relatesTo>
 <event> ?? 0..* BackboneElement  <!-- ?? 0..* The clinical service(s) being documented -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- 0..* CodeableConcept Code(s) that apply to the event being documented   --></code>
  <period><!-- 0..1 Period 
      The period covered by the documentation --></period>
  <detail><!-- 0..* Reference(Resource) 
      The event(s) being documented --></detail>
 </event>
 <section> ?? 0..* BackboneElement  <!-- ?? 0..* Composition is broken into sections -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <title value="[string]"/><!-- 0..1 Label for section (e.g. for ToC) -->
  <code><!-- 0..1 CodeableConcept Classification of section (recommended)   --></code>
  <author><!-- 0..* Reference(Practitioner) 
      Who and/or what authored the section --></author>
  <focus><!-- 0..1 Reference(Resource) 
      Who/what the section is about, when it is not about the subject of composition --></focus>
  <text><!-- 0..1 Narrative 
      Text summary of the section, for human interpretation --></text>
  <mode value="[code]"/><!-- 0..1 working | snapshot | changes   -->
  <orderedBy><!-- 0..1 CodeableConcept Order of section entries   --></orderedBy>
  <entry><!-- 1..* Reference(CatalogEntry) 
      The Content of the section --></entry>
  <emptyReason><!-- 0..1 CodeableConcept Why the section is empty   --></emptyReason>
  <section><!-- See #Composition.section  Nested Section --></section>
 </section>
</Composition>
{ // Profile for Catalog
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //Text 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 // C? R! 
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : { Identifier }, //Version-independent identifier for the Composition
    "status" : "<code>", // R! preliminary | final | amended | entered-in-error
    "type" : { CodeableConcept }, // R! 
    "category" : { CodeableConcept }, // R! The Content of the section
    "encounter" : { Reference(Encounter) }, //Context of the Composition
    "date" : "<dateTime>", // R! When the Catalog was created
    "author" : [{ Reference(Practitioner) }], // R! Who and/or what authored the composition
    "title" : "<string>", // R! Human Readable name/title
    "confidentiality" : "<code>", //As defined by affinity domain
    "attester" : [{ BackboneElement }], // C?Attests to accuracy of composition
    "custodian" : { Reference(Organization) }, //Organization which maintains the composition
    "relatesTo" : [{ BackboneElement }], // C?Relationships to other compositions/documents
    "event" : [{ BackboneElement }], // C?The clinical service(s) being documented
    "section" : [{ BackboneElement }], // C?Composition 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 Composition.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*A set of resources composed into a single coherent clinical statement with clinical attestation
... cqm-ValidityPeriod 1..1dateTimeThe validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
... type 1..1CodeableConceptThe type of document - a Catalog
Fixed Value: {"text":"Catalog"}
... category 1..1CodeableConceptThe Content of the section
Binding: CatalogType (example)
... subject 0..0
... date 1..1dateTimeWhen the Catalog was created
... section 0..*BackboneElement
.... entry 1..*Reference(CatalogEntry)The Content of the section

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition I0..*A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqm-ValidityPeriod I1..1dateTimeThe validity of the catalog
URL: http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type Σ1..1CodeableConceptThe type of document - a Catalog
Binding: FHIR Document Type Codes (preferred)
Fixed Value: {"text":"Catalog"}
... category Σ1..1CodeableConceptThe Content of the section
Binding: CatalogType (example)
... encounter Σ0..1Reference(Encounter)Context of the Composition
... date Σ1..1dateTimeWhen the Catalog was created
... author Σ1..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
... confidentiality Σ0..1codeAs defined by affinity domain
Binding: ConfidentialityClassification (required)
... attester I0..*BackboneElementAttests to accuracy of composition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required)
.... time 0..1dateTimeWhen the composition was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
... custodian Σ0..1Reference(Organization)Organization which maintains the composition
... relatesTo I0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target[x] 1..1Identifier, Reference(Composition)Target of the relationship
... event ΣI0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: ActCode (example)
.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section I0..*BackboneElementComposition is broken into sections
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: Document Section Codes (example)
.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required)
.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: List Order Codes (preferred)
.... entry I1..*Reference(CatalogEntry)The Content of the section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: List Empty Reasons (preferred)
.... section I0..*Unknown reference to #Composition.section
Nested Section

doco Documentation for this format

XML Template

<!-- Profile for Catalog -->doco

<Composition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content   -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..1 Identifier 
     Version-independent identifier for the Composition --></identifier>
 <status value="[code]"/><!-- 1..1 preliminary | final | amended | entered-in-error   -->
 <type><!-- 1..1 CodeableConcept The type of document - a Catalog   --></type>
 <category><!-- 1..1 CodeableConcept The Content of the section   --></category>
 <subject><!-- 0..0 Reference(Resource) 
     Who and/or what the composition is about --></subject>
 <encounter><!-- 0..1 Reference(Encounter) Context of the Composition --></encounter>
 <date value="[dateTime]"/><!-- 1..1 When the Catalog was created -->
 <author><!-- 1..* Reference(Practitioner) 
     Who and/or what authored the composition --></author>
 <title value="[string]"/><!-- 1..1 Human Readable name/title -->
 <confidentiality value="[code]"/><!-- 0..1 As defined by affinity domain   -->
 <attester> ?? 0..* BackboneElement  <!-- ?? 0..* Attests to accuracy of composition -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <mode value="[code]"/><!-- 1..1 personal | professional | legal | official   -->
  <time value="[dateTime]"/><!-- 0..1 When the composition was attested -->
  <party><!-- 0..1 Reference(Patient) 
      Who attested the composition --></party>
 </attester>
 <custodian><!-- 0..1 Reference(Organization) 
     Organization which maintains the composition --></custodian>
 <relatesTo> ?? 0..* BackboneElement  <!-- ?? 0..* Relationships to other compositions/documents -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- 1..1 replaces | transforms | signs | appends   -->
  <target[x]><!-- 1..1 Identifier|Reference(Composition) 
      Target of the relationship --></target[x]>
 </relatesTo>
 <event> ?? 0..* BackboneElement  <!-- ?? 0..* The clinical service(s) being documented -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- 0..* CodeableConcept Code(s) that apply to the event being documented   --></code>
  <period><!-- 0..1 Period 
      The period covered by the documentation --></period>
  <detail><!-- 0..* Reference(Resource) 
      The event(s) being documented --></detail>
 </event>
 <section> ?? 0..* BackboneElement  <!-- ?? 0..* Composition is broken into sections -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <title value="[string]"/><!-- 0..1 Label for section (e.g. for ToC) -->
  <code><!-- 0..1 CodeableConcept Classification of section (recommended)   --></code>
  <author><!-- 0..* Reference(Practitioner) 
      Who and/or what authored the section --></author>
  <focus><!-- 0..1 Reference(Resource) 
      Who/what the section is about, when it is not about the subject of composition --></focus>
  <text><!-- 0..1 Narrative 
      Text summary of the section, for human interpretation --></text>
  <mode value="[code]"/><!-- 0..1 working | snapshot | changes   -->
  <orderedBy><!-- 0..1 CodeableConcept Order of section entries   --></orderedBy>
  <entry><!-- 1..* Reference(CatalogEntry) 
      The Content of the section --></entry>
  <emptyReason><!-- 0..1 CodeableConcept Why the section is empty   --></emptyReason>
  <section><!-- See #Composition.section  Nested Section --></section>
 </section>
</Composition>

JSON Template

{ // Profile for Catalog
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //Text 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 // C? R! 
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : { Identifier }, //Version-independent identifier for the Composition
    "status" : "<code>", // R! preliminary | final | amended | entered-in-error
    "type" : { CodeableConcept }, // R! 
    "category" : { CodeableConcept }, // R! The Content of the section
    "encounter" : { Reference(Encounter) }, //Context of the Composition
    "date" : "<dateTime>", // R! When the Catalog was created
    "author" : [{ Reference(Practitioner) }], // R! Who and/or what authored the composition
    "title" : "<string>", // R! Human Readable name/title
    "confidentiality" : "<code>", //As defined by affinity domain
    "attester" : [{ BackboneElement }], // C?Attests to accuracy of composition
    "custodian" : { Reference(Organization) }, //Organization which maintains the composition
    "relatesTo" : [{ BackboneElement }], // C?Relationships to other compositions/documents
    "event" : [{ BackboneElement }], // C?The clinical service(s) being documented
    "section" : [{ BackboneElement }], // C?Composition is broken into sections
  }

 

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

PathNameConformanceValueSet
Composition.languageCommon LanguagespreferredCommon Languages
Composition.statusCompositionStatusrequiredCompositionStatus
Composition.typeFHIR Document Type CodespreferredFHIR Document Type Codes
Composition.categoryCatalogTypeexampleCatalogType
Composition.confidentialityV3 Value SetConfidentialityClassificationrequiredV3 Value SetConfidentialityClassification
Composition.attester.modeCompositionAttestationModerequiredCompositionAttestationMode
Composition.relatesTo.codeDocumentRelationshipTyperequiredDocumentRelationshipType
Composition.event.codev3 Code System ActCodeexamplev3 Code System ActCode
Composition.section.codeDocument Section CodesexampleDocument Section Codes
Composition.section.modeListModerequiredListMode
Composition.section.orderedByList Order CodespreferredList Order Codes
Composition.section.emptyReasonList Empty ReasonspreferredList Empty Reasons
.