DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 3). 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 R3 R2 R3 R2

Comments Definition
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. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained. Clinical Quality Information Control 0..* Work Group Type Maturity Level : 2 Composition   Trial Use 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. Compartments : Patient Composition.id

The logical id of Detailed Descriptions for the resource, as used elements in the URL for the MeasureReport resource. Once assigned, this value never changes. Control 0..1 Type id 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.

Alternate Names Alternate Names extensions, user content Comments 1..1 Requirements Key metadata element describing the composition, used in searching/filtering. Comments Requirements Identifies responsibility for the accuracy of the composition content. 0..* Alternate Names extensions, user content Comments Alternate Names extensions, user content, modifiers 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. 0..1 Requirements Composition.event.modifierExtension Alternate Names extensions, user content, modifiers 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. 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. Requirements Provides context for the composition and supports searching. Invariants Alternate Names Type Composition.section.text Requirements Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Composition.meta MeasureReport
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. Control 0..1 Type Meta Composition.implicitRules Definition A reference to a set of rules that were followed when the MeasureReport resource was constructed, and which must be understood when processing the content. Control 0..1 Type uri Is Modifier true Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits contains the usefulness results 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 evaluating 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. measure.

Control 0..1 Binding A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 Type code 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). 1..1
Composition.text MeasureReport.identifier
Definition

A human-readable narrative formal identifier 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 used to make identify this report when it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be is represented in the narrative to ensure clinical safety. Control 0..1 This element is affected by the following invariants: dom-1 Type Narrative Alternate Names narrative, html, xhtml, display Comments Contained resources do not have narrative. Resources that are not contained SHOULD have other formats, or referenced in a narrative. Composition.contained Definition These resources do not have specification, model, design or 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. instance.

Control 0..* Type Resource Alternate Names inline resources, anonymous resources, contained resources Comments Note 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 business identifer, not a set of requirements that SHALL be met as part of the definition of the extension. resource identifier (see discussion )
Control 0..* 0..1
Type Extension Identifier
extensions, user content Comments Requirements

There can Allows externally provided and/or usable business identifiers to be no stigma easily 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. module.

Control 0..* Type Extension Is Modifier Summary true
Comments

There Typically, this is used for identifiers that can be no stigma associated with the use of extensions by any application, project, or standard go in an HL7 v3 II data type - regardless e.g. to identify this {{title}} outside of FHIR, where the institution or jurisdiction that uses or defines the extensions. The use of extensions logical URL is what allows the FHIR specification not possible to retain a core level of simplicity for everyone. use.

Composition.identifier MeasureReport.status
Definition

Logical Identifier for the composition, assigned when created. This identifier stays constant as The report status. No data will be available until the composition report status is changed over time. complete.

Control 0..1 1..1
Type Identifier Terminology Binding See discussion in resource definition for how these relate. MeasureReportStatus Composition.date Definition The composition editing time, when the composition was last logically changed by the author. Control ( Required 1..1 )
Type dateTime 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. Control code
Binding Is Modifier Type of a composition. The codes SHOULD be taken from FHIR Document Type Codes true
Type CodeableConcept Summary For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. true
Composition.class MeasureReport.type
Definition

A categorization for the The type of the composition. measure report. This may be implied by or derived from the code specified in the Composition Type. Control 0..1 Binding High-level kind of a clinical document at a macro level. For example codes, see FHIR Document Class Codes Type CodeableConcept Requirements Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. Comments This is individual report, which provides a metadata field from XDS/MHD . Composition.title Definition Official human-readable label single patient's score for the composition. Control 1..1 Type string Comments For many compositions, measure; a patient listing, which returns the title is list of patients that meet the same as various criteria in the text measure; or a display name of Composition.type (e.g. summary report, which returns a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful population count for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period. Composition.status Definition The workflow/clinical status each of this composition. The status is a marker for the clinical standing of criteria in the document. measure.

Control 1..1
Terminology Binding The workflow/clinical status of the composition. The codes SHALL be taken from CompositionStatus MeasureReportType ( Required )
Type code
Is Modifier Summary true
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 This element is labeled as a modifier of other elements. Some reporting work flows require that because the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required. Composition.confidentiality Definition The code specifying the level of confidentiality of the Composition. Control 1..1 Binding Codes specifying the level of confidentiality of the composition. The contains codes SHALL be taken from v3 Code System Confidentiality Type code Is Modifier true Comments The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for that mark the base specification, and delegated to implementation profiles (see security section). resource as not currently valid.

Composition.subject MeasureReport.measure
Definition

Who or what A reference to 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 Measure that share a common exposure). was evaluated to produce this report.

Control 1..1
Type Choice of: Reference ( Patient ), Reference ( Practitioner ), Reference ( Group ), Reference ( Device ), Reference ( Location Measure )
Requirements For a mreasure report, the subject indicates who ior what is being measured? For example, the provider, hospital, or health plan that is being measured by the scores included in the report. Summary Comments if a report contains the results of more than one measure, each measure should be measuring the same entity. true
Composition.author MeasureReport.patient
Definition

Identifies who is responsible for the information in Optional Patient if the composition. (Not necessarily who typed it in.). report was requested for a single patient.

Control 1..* 0..1
Type Choice of: Reference ( Practitioner ), Reference ( Device ), Reference ( Patient ), Reference ( RelatedPerson )
Requirements Identifies who is responsible for the content. Composition.attester Definition A participant who has attested to the accuracy of the composition/document. Control 0..* Type BackboneElement Summary Comments Only list each attester once. true
Composition.attester.id MeasureReport.date
Definition

unique id for the element within a resource (for internal references). The date this measure report was generated.

Control 0..1
Type id Composition.attester.extension Definition May be used to represent additional information that is not part of the basic definition of the element. 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. Control dateTime
Type Extension Summary 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. true
Composition.attester.modifierExtension MeasureReport.reportingOrganization
Definition

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 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. Reporting Organization.

Control 0..* 0..1
Type Extension Reference ( Organization )
Is Modifier Summary true
Composition.attester.mode MeasureReport.period
Definition

The type of attestation reporting period for which the authenticator offers. report was calculated.

Control 1..* Binding The way in which a person authenticated a composition. The codes SHALL be taken from CompositionAttestationMode 1..1
Type code Requirements Indicates the level of authority 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. Control Period
Type dateTime Summary Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). true
Composition.attester.party MeasureReport.group
Definition

Who attested The results of the composition calculation, one for each population group in the specified way. measure.

Control 0..1 0..*
Type Choice of: Reference ( Patient ), Reference ( Practitioner ), Reference ( Organization Summary ) Requirements Identifies who has taken on the responsibility for accuracy of the composition content. false
Composition.custodian MeasureReport.group.identifier
Definition

Identifies the organization or group who is responsible for ongoing maintenance The identifier of and access to the composition/document information. Control 0..1 Type Reference ( Organization ) Requirements Identifies where to go to find population group as defined in the current version, where to report issues, etc. measure definition.

Comments Note 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 this is sometimes business identifer, not known by the authoring system, and can be inferred by context. However it is important that this information be known when working with a derived document, so providing a custodian is encouraged. resource identifier (see discussion Composition.event Definition The clinical service, such as a colonoscopy or an appendectomy, being documented. )
Control 0..0 1..1
Type BackboneElement Identifier
Must Support Summary true Requirements The report's results will typically span many cases that may each span many events. Comments The event needs to be consistent with the type element, though can provide further information if desired. false
Composition.event.id MeasureReport.group.population
Definition

unique id The populations that make up the population group, one for each type of population appropriate for the element within a resource (for internal references). measure.

Control 0..1 0..*
Type Summary id false
Composition.event.extension MeasureReport.group.population.identifier
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set The identifier 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 population being reported, as part of the definition of the extension. Control 0..* Type Extension Alternate Names extensions, user content Comments There can be no stigma associated with the use of extensions defined by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use population element of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. measure.

Definition Note 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 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 This is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing business identifer, not a resource are required to check for modifier extensions. identifier (see discussion )
Control 0..* 0..1
Type Extension Identifier
Is Modifier Summary true
Composition.event.code MeasureReport.group.population.code
Definition

This list The type 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. population.

Control 0..0 0..1
Terminology Binding This list of codes represents the main clinical acts being documented. For example codes, see v3 Code System ActCode MeasurePopulationType ( Extensible )
Type CodeableConcept
Must Support Summary true
Composition.event.period MeasureReport.group.population.count
Definition

The period number of members 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. population.

Control 0..0 0..1
Type Period integer
Must Support Summary true false
Composition.event.detail MeasureReport.group.population.patients
Definition

Full details This element refers to a List of patient level MeasureReport resources, one for the event(s) the composition/documentation consents. each patient in this population.

Control 0..0 0..1
Type Reference ( Resource List )
Must Support Summary true false
Composition.encounter MeasureReport.group.measureScore
Definition

Describes The measure score for this population group, calculated as appropriate for the clinical encounter or measure type and scoring method, and based on the contents of care this documentation is associated with. the populations defined in the group.

Control 0..0 0..1
Type Reference ( Encounter decimal )
Must Support Summary true
Composition.section MeasureReport.group.stratifier
Definition

The root of the contents that make up When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the composition. measure.

Control 0..*
Type BackboneElement Summary Defined on this element cmp-1 : A section must at least one of text, entries, or sub-sections (xpath: exists(f:text) or exists(f:entry) or exists(f:section)) cmp-2 : A section can only have an emptyReason if it is empty (xpath: not(exists(f:emptyReason) and exists(f:entry))) false
Composition.section.id MeasureReport.group.stratifier.identifier
Definition

unique id for The identifier of this stratifier, as defined in the element within a resource (for internal references). measure definition.

Control 0..1 Type id Composition.section.extension Definition Note May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there This 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 business identifer, not a set of requirements that SHALL be met as part of the definition of the extension. resource identifier (see discussion )
Control 0..* 0..1
Type Extension Identifier
extensions, user content Summary 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. false
Composition.section.modifierExtension MeasureReport.group.stratifier.stratum
Definition

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 This element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is results for a strict set of governance applied to single stratum within the definition and use of extensions. Though any implementer is allowed to define an extension, stratifier. For example, when stratifying on administrative gender, there is a set of requirements that SHALL will be met as part of the definition of the extension. Applications processing a resource are required to check four strata, one for modifier extensions. each possible gender value.

Control 0..*
Type Extension Is Modifier Summary true Alternate Names extensions, user content, modifiers 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. false
Composition.section.title MeasureReport.group.stratifier.stratum.value
Definition

The heading value for this particular section. This will be part of stratum, expressed as a string. When defining stratifiers on complex values, the value must be rendered content such that the value for each stratum within the document. stratifier is unique.

Control 0..1 1..1
Type string
Requirements Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. Alternate Names header, label, caption Summary 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. Generally, sections SHOULD have titles, but in some documents it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. false
Composition.section.code MeasureReport.group.stratifier.stratum.population
Definition

A code identifying The populations that make up the kind stratum, one for each type of content contained within the section. This must be consistent with population appropriate to the section title. measure.

Control 0..1 0..*
Binding Summary Classification of a section of a composition/document. For example codes, see Document Section Codes false
CodeableConcept Requirements MeasureReport.group.stratifier.stratum.population.identifier Provides computable standardized labels to topics within the document.
Comments Definition

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. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation identifier of the resource that is population being reported, as defined by the content population element of the section in the comments for the section.code. measure.

Definition Note A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to This is a human. The narrative need business identifer, 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 identifier (see discussion )
Control 0..1 This element is affected by the following invariants: cmp-1
Type Narrative Identifier
Comments Summary Document profiles may define what content should be represented in the narrative to ensure clinical safety. true
Composition.section.mode MeasureReport.group.stratifier.stratum.population.code
Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list The type of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. the population.

Control 0..1
Terminology Binding The processing mode that applies to this section. The codes SHALL be taken from ListMode MeasurePopulationType ( Extensible )
Type code CodeableConcept
Is Modifier Summary true
Composition.section.orderedBy MeasureReport.group.stratifier.stratum.population.count
Definition

Specifies the order applied to The number of members of the items population in the section entries. this stratum.

Control 0..1
Binding What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes Type CodeableConcept integer
Requirements Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. Summary Comments Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. false
Composition.section.entry MeasureReport.group.stratifier.stratum.population.patients
Definition

The content (narrative and data) associated with the section. This element refers to a List of patient level MeasureReport resources, one for each patient in this population in this stratum.

Control 1..1 This element is affected by the following invariants: cmp-2 0..1
Type Reference ( Observation List )
Comments Summary If there are no entries in the list, an emptyReason SHOULD be provided. false
Composition.section.emptyReason MeasureReport.group.stratifier.stratum.measureScore
Definition

If the section is empty, why The measure score for this stratum, calculated as appropriate for the list is empty. An empty section typically has some text explaining measure type and scoring method, and based on only the empty reason. members of this stratum.

Control 0..1 This element is affected by the following invariants: cmp-2 Binding If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons
Type CodeableConcept decimal
Requirements Allows capturing things like "none exist" or "not asked" which can be important for most lists. Summary Comments The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. true
Composition.section.section MeasureReport.evaluatedResources
Definition

A nested sub-section within reference to a Bundle containing the Resources that were used in the evaluation of this section. report.

Control 0..* This element is affected by the following invariants: cmp-1 0..1
Type See section Reference ( Bundle )
Comments Summary Nested sections are primarily used to help human readers navigate to particular portions of the document. false