2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile - Definitions

Todo

Definitions for the cda-clinicaldocument Profile.

Composition
Definition

A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.

Control1..1
TypeResource
Requirements

To support documents, and also to capture the EN13606 notion of an attested commit to the patient EHR, and to allow a set of disparate resources at the information/engineering level to be gathered into a clinical statement.

Comments

While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.

Composition.id
Definition

The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.

Control0..1
Typeid
Requirements
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Composition.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Requirements
Comments
Composition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Requirements
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Composition.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource

Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Composition.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Requirements
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Composition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Requirements
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Composition.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Composition.modifierExtension
Definition

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. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Composition.identifier
Definition

Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.

Control0..1
TypeIdentifier
Requirements
Comments

See discussion in resource definition for how these relate.

Composition.date
Definition

The composition editing time, when the composition was last logically changed by the author.

Control1..1
TypedateTime
Requirements

dateTime is used for tracking, organizing versions and searching.

Comments

The Last Modified Date on the composition may be after the date of the document was attested without being changed.

Composition.type
Definition

Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

Control1..1
BindingType of a composition
The codes SHOULD be taken from FHIR Document Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Key metadata element describing the composition, used in searching/filtering.

Comments
Composition.class
Definition

A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type.

Control0..0
BindingSubType of a clinical document
For example codes, see XDS Connect-a-thon healthcareFacilityTypeCodes
TypeCodeableConcept
Requirements

Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.

Comments
Composition.title
Definition

Official human-readable label for the composition.

Control0..1
Typestring
Requirements
Comments

If compositions do not have a title, the text or a display name of Composition.type (e.g. a "consultation" or "progress note") can be used in its place.

Composition.status
Definition

CDA: all documents are final

Control1..1
BindingThe workflow/clinical status of the composition
The codes SHALL be taken from CompositionStatus
Typecode
Is Modifiertrue
Requirements

Need to be able to mark interim, amended, or withdrawn compositions or documents.

Comments

If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "withdrawn" is why this element is labeled as a modifier of other elements.

Fixed Valuefinal
Composition.confidentiality
Definition

The code specifying the level of confidentiality of the Composition.

Control1..1
BindingCodes specifying the level of confidentiality of the composition
The codes SHOULD be taken from v3 Code System Confidentiality; other codes may be used where these codes are not suitable
TypeCoding
Is Modifiertrue
Requirements
Comments

The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for FHIR, and delegated to implementation profiles (see security section).

Composition.subject
Definition

Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

Control1..1
TypeReference(Profile = #PatientRole)
Requirements

Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.

Comments

For clinical documents, this is usually the patient.

Composition.author
Definition

Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.).

Control1..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Device)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson))
Requirements

Identifies who is responsible for the content.

Comments
Composition.attester
Definition

A participant who has attested to the accuracy of the composition/document.

Control0..*
Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Composition.attester.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Composition.attester.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Composition.attester.modifierExtension
Definition

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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers, extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Composition.attester.mode
Definition

The type of attestation the authenticator offers.

Control1..*
BindingThe way in which a person authenticated a composition
For codes, see CompositionAttestationMode
Typecode
Requirements

Indicates the level of officialness of the attestation.

Comments

Use more than one code where a single attester has more than one mode (professional and legal are often paired).

Composition.attester.time
Definition

When composition was attested by the party.

Control0..1
TypedateTime
Requirements

Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

Comments
Composition.attester.party
Definition

Who attested the composition in the specified way.

Control0..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Requirements

Identifies who has taken on the responsibility for accuracy of the composition content.

Comments
Composition.custodian
Definition

Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Requirements

Identifies where to go to find the current version, where to report issues, etc.

Comments

This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because knowing this is sometimes not known by the authoring system, and can be inferred by context. However it's important that this information be known when working with a derived document, so providing a custodian is encouraged.

Composition.event
Definition

The main event/act/item, such as a colonoscopy or an appendectomy, being documented.

Control0..1
Requirements

Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.

Comments

The event needs to be consistent with the type element, though can provide further information if desired.

Composition.event.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Composition.event.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Composition.event.modifierExtension
Definition

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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers, extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Composition.event.code
Definition

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

Control0..*
BindingThis list of codes represents the main clinical acts being documented
For codes, see v3 Code System ActCode
TypeCodeableConcept
Requirements
Comments

An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as ???key words??? for certain types of queries.

Composition.event.period
Definition

The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.

Control0..1
TypePeriod
Requirements
Comments
Composition.event.detail
Definition

Full details for the event(s) the composition/documentation consents.

Control0..*
TypeReference(Profile = http://hl7.org/fhir/Profile/Any)
Requirements
Comments
Composition.encounter
Definition

Describes the clinical encounter or type of care this documentation is associated with.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Encounter))
Requirements

Provides context for the composition and supports searching.

Comments
Composition.section(section)
Definition

The root of the sections that make up the composition.

Control0..*
Requirements
Comments
InvariantsDefined on this element
2: A section SHALL have content or one or more sections, but not both. (xpath: exists(f:content) != exists(f:section))
cmp-1: A section can only have a code if it has no content (xpath: not(exists(f:code)) or not(exists(f:content)))
cmp-2: A section must have either subsections or content (xpath: (exists(f:content) and not(exists(f:section))) or (exists(f:section) and not(exists(f:content))))
Composition.section.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Composition.section.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Composition.section.modifierExtension
Definition

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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers, extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Composition.section.title
Definition

The heading for this particular section. This will be part of the rendered content for the document.

Control0..1
Typestring
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
Comments

The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference.

Composition.section.code
Definition

A code identifying the kind of content contained within the section.

Control0..1 This element is affected by the following invariants: cmp-1
BindingClassification of a composition / document
For codes, see Document Section Codes
TypeCodeableConcept
Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. Code is not required or allowed if there is content, since the meaning of the section can be ascertained from the resource that is the target of the section.content reference.

Composition.section.section
Definition

A nested sub-section within this section.

Control0..*
TypeSee section
Requirements
Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Composition.section.content
Definition

The content (narrative and data) associated with the section.

Control0..1 This element is affected by the following invariants: cmp-1
TypeReference(Profile = http://hl7.org/fhir/Profile/Any)
Requirements
Comments

Because composition represent point-in-time snapshots, resource references should either be to a specific version, or made against resources on the same server with full version tracking, so that the correct versions can easily be assembled.