QI-Core Implementation Guide
7.0.0-ballot - STU7 United States of America flag

QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions

Resource Profile: QICore BodyStructure

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-bodystructure Version: 7.0.0-ballot
Active as of 2018-08-22 Computable Name: QICoreBodyStructure

Profile of BodyStructure for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

QI Elements:
  • active: (QI) Whether this record is in active use
  • location: (QI) Body site
  • locationQualifier: (QI) Body site modifier
  • patient: (QI) Who this is about
Primary code path: location
(PCPath) This element is the primary code path for this resource CQL Retrieve


NOTE TO BALLOT REVIEWERS:
  • US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.
    • As noted in the US Core 7.0 Must Support section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.
    • Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.
  • We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.
  • Further, QI-Core 7.0 does not discuss USCDI+Quality because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.

Usage

See the patterns page for implementation and usage patterns.

Examples

BodyStructure Example - identifying a specific tumor or lesion

Usage:

Formal Views of Profile Content

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

This structure is derived from BodyStructure

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... active 1..1 boolean (QI) Whether this record is in active use
... location 1..1 CodeableConcept (QI) Body site
Binding: SNOMEDCTBodyStructures (preferred)
... locationQualifier 0..* CodeableConcept (QI) Body site modifier
Binding: BodystructureLocationQualifier (preferred): Concepts modifying the anatomic location


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BodyStructure.locationpreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
BodyStructure.locationQualifierpreferredBodystructureLocationQualifier
http://hl7.org/fhir/ValueSet/bodystructure-relative-location
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 1..1 boolean (QI) Whether this record is in active use
... locationQualifier 0..* CodeableConcept (QI) Body site modifier
Binding: BodystructureLocationQualifier (preferred): Concepts modifying the anatomic location


... patient Σ 1..1 Reference(QICore Patient) (QI) Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.locationpreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
BodyStructure.locationQualifierpreferredBodystructureLocationQualifier
http://hl7.org/fhir/ValueSet/bodystructure-relative-location
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBodyStructureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBodyStructureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBodyStructureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Bodystructure identifier
... active ?!Σ 1..1 boolean (QI) Whether this record is in active use
... morphology Σ 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (example): Codes describing anatomic morphology.

... location Σ 1..1 CodeableConcept (QI) Body site
Binding: SNOMEDCTBodyStructures (preferred)
... locationQualifier 0..* CodeableConcept (QI) Body site modifier
Binding: BodystructureLocationQualifier (preferred): Concepts modifying the anatomic location


... description Σ 0..1 string Text description
... image 0..* Attachment Attached images
... patient Σ 1..1 Reference(QICore Patient) (QI) Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
BodyStructure.morphologyexampleSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
BodyStructure.locationQualifierpreferredBodystructureLocationQualifier
http://hl7.org/fhir/ValueSet/bodystructure-relative-location
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBodyStructureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBodyStructureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBodyStructureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from BodyStructure

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from BodyStructure

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... active 1..1 boolean (QI) Whether this record is in active use
... location 1..1 CodeableConcept (QI) Body site
Binding: SNOMEDCTBodyStructures (preferred)
... locationQualifier 0..* CodeableConcept (QI) Body site modifier
Binding: BodystructureLocationQualifier (preferred): Concepts modifying the anatomic location


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BodyStructure.locationpreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
BodyStructure.locationQualifierpreferredBodystructureLocationQualifier
http://hl7.org/fhir/ValueSet/bodystructure-relative-location
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 1..1 boolean (QI) Whether this record is in active use
... locationQualifier 0..* CodeableConcept (QI) Body site modifier
Binding: BodystructureLocationQualifier (preferred): Concepts modifying the anatomic location


... patient Σ 1..1 Reference(QICore Patient) (QI) Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.locationpreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
BodyStructure.locationQualifierpreferredBodystructureLocationQualifier
http://hl7.org/fhir/ValueSet/bodystructure-relative-location
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBodyStructureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBodyStructureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBodyStructureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Bodystructure identifier
... active ?!Σ 1..1 boolean (QI) Whether this record is in active use
... morphology Σ 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (example): Codes describing anatomic morphology.

... location Σ 1..1 CodeableConcept (QI) Body site
Binding: SNOMEDCTBodyStructures (preferred)
... locationQualifier 0..* CodeableConcept (QI) Body site modifier
Binding: BodystructureLocationQualifier (preferred): Concepts modifying the anatomic location


... description Σ 0..1 string Text description
... image 0..* Attachment Attached images
... patient Σ 1..1 Reference(QICore Patient) (QI) Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
BodyStructure.morphologyexampleSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
BodyStructure.locationQualifierpreferredBodystructureLocationQualifier
http://hl7.org/fhir/ValueSet/bodystructure-relative-location
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBodyStructureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBodyStructureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBodyStructureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from BodyStructure

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron