HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)
This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-statement-ComponentOnlyNonLaboratoryObservation
An observation with components, but without a result value or panel members.
This profile builds on US Core Results Profile.
This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC).
View the corresponding ComponentOnlyNonLaboratoryObservationModel logical model.
Summary
Fixed Value: 1 element
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.statement.ComponentOnlyNonLaboratoryObservation maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-observationresults: PersonOfRecord maps to subject ObservationTopic.TopicCode maps to code ObservationTopic.FindingMethod maps to method ObservationTopic.Details maps to comment ObservationTopic.Category maps to category ObservationTopic.AnatomicalLocation maps to bodySite ObservationTopic.Device maps to device ObservationTopic.Specimen maps to specimen ObservationTopic.ReferenceRange maps to referenceRange ObservationTopic.ReferenceRange.Range.LowerBound maps to referenceRange.low ObservationTopic.ReferenceRange.Range.UpperBound maps to referenceRange.high ObservationTopic.ReferenceRange.Type maps to referenceRange.type ObservationTopic.ReferenceRange.ApplicableSubpopulation maps to referenceRange.appliesTo ObservationTopic.ReferenceRange.ApplicableAgeRange maps to referenceRange.age ObservationTopic.EvaluationComponent maps to component (slice on = coding.code; slice strategy = includes) ObservationTopic.EvaluationComponent._Concept maps to component.code ObservationTopic.EvaluationComponent.Quantity maps to component.value[x] ObservationTopic.EvaluationComponent.CodeableConcept maps to component.value[x] ObservationTopic.EvaluationComponent.string maps to component.value[x] ObservationTopic.EvaluationComponent.Range maps to component.value[x] ObservationTopic.EvaluationComponent.Ratio maps to component.value[x] ObservationTopic.EvaluationComponent.Media maps to component.value[x] ObservationTopic.EvaluationComponent.time maps to component.value[x] ObservationTopic.EvaluationComponent.dateTime maps to component.value[x] ObservationTopic.EvaluationComponent.TimePeriod maps to component.value[x] ObservationTopic.EvaluationComponent.IntegerQuantity maps to component.value[x] ObservationTopic.EvaluationComponent.ExceptionValue maps to component.dataAbsentReason ObservationTopic.EvaluationComponent.Interpretation maps to component.interpretation ObservationTopic.EvaluationComponent.ReferenceRange maps to component.referenceRange fix related.type to #has-member ObservationTopic.PanelMembers maps to related ObservationTopic.PanelMembers.Observation maps to related.target (slice at = related; slice on = target.reference.resolve(); slice on type = profile; slice strategy = includes) ObservationContext.ResultValue maps to value[x] ObservationContext.ExceptionValue maps to dataAbsentReason ObservationContext.Interpretation maps to interpretation ObservationContext.Issued maps to issued ObservationContext.FindingStatus maps to status ObservationContext.RelevantTime maps to effective[x] ObservationContext.DeltaFlag maps to http://hl7.org/fhir/StructureDefinition/observation-delta
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | BC ComponentOnlyNonLaboratoryObservation Profile | |||
  observation-delta | 0..1 | CodeableConcept | Qualitative change or trend in the measurement URL: http://hl7.org/fhir/StructureDefinition/observation-delta | |
| category | Binding: Observation Category Codes (extensible) | |||
 value[x] | 0..0 | |||
| dataAbsentReason | 0..0 | |||
| bodySite | Binding: BC AnatomicalLocationVS ValueSet (required) | |||
| method | Binding: http://loinc.org/vs (preferred) | |||
 specimen | 0..0 | |||
| device | Reference(US Core Device Profile) | |||
| referenceRange | 0..0 | |||
| related | 0..0 | |||
 component | ||||
 value[x] | Quantity, CodeableConcept, string, Range, RatioProfile, Attachment, time, dateTime, Period | |||
| dataAbsentReason | Binding: DataAbsentReason (extensible) | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | BC ComponentOnlyNonLaboratoryObservation Profile us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present | |
 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 |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 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 Slice: Unordered, Open by value:url | |
| observation-delta | 0..1 | CodeableConcept | Qualitative change or trend in the measurement URL: http://hl7.org/fhir/StructureDefinition/observation-delta | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for observation |
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) | Fulfills plan, proposal or order |
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
| category | SI | 1..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (extensible) us-core-5: Must have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category' |
| code | SΣ | 1..1 | CodeableConcept | Laboratory Test Name Binding: LOINC Codes (extensible) |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what this is about |
| context | 0..1 | Reference(Encounter | EpisodeOfCare) | Healthcare event during which this observation is made | |
| effective[x] | SΣI | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation us-core-1: Datetime must be at least to day. |
| issued | Σ | 0..1 | instant | Date/Time this was made available |
| performer | Σ | 0..* | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
| comment | 0..1 | string | Comments about result | |
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: BC AnatomicalLocationVS ValueSet (required) | |
| method | 0..1 | CodeableConcept | How it was done Binding: http://loinc.org/vs (preferred) | |
| device | 0..1 | Reference(US Core Device Profile) | (Measurement) Device | |
| component | ΣI | 0..* | BackboneElement | Component results |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
| value[x] | Σ | 0..1 | Quantity, CodeableConcept, string, Range, RatioProfile, Attachment, time, dateTime, Period | Actual component result |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
| referenceRange | 0..* | BackboneElement | Provides guide for interpretation of component result | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | I | 0..1 | SimpleQuantity | High Range, if relevant |
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
| age | 0..1 | Range | Applicable age range, if relevant | |
| text | 0..1 | string | Text based reference range in an observation | |
| Documentation for this format | ||||
Summary
Fixed Value: 1 element
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.statement.ComponentOnlyNonLaboratoryObservation maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-observationresults: PersonOfRecord maps to subject ObservationTopic.TopicCode maps to code ObservationTopic.FindingMethod maps to method ObservationTopic.Details maps to comment ObservationTopic.Category maps to category ObservationTopic.AnatomicalLocation maps to bodySite ObservationTopic.Device maps to device ObservationTopic.Specimen maps to specimen ObservationTopic.ReferenceRange maps to referenceRange ObservationTopic.ReferenceRange.Range.LowerBound maps to referenceRange.low ObservationTopic.ReferenceRange.Range.UpperBound maps to referenceRange.high ObservationTopic.ReferenceRange.Type maps to referenceRange.type ObservationTopic.ReferenceRange.ApplicableSubpopulation maps to referenceRange.appliesTo ObservationTopic.ReferenceRange.ApplicableAgeRange maps to referenceRange.age ObservationTopic.EvaluationComponent maps to component (slice on = coding.code; slice strategy = includes) ObservationTopic.EvaluationComponent._Concept maps to component.code ObservationTopic.EvaluationComponent.Quantity maps to component.value[x] ObservationTopic.EvaluationComponent.CodeableConcept maps to component.value[x] ObservationTopic.EvaluationComponent.string maps to component.value[x] ObservationTopic.EvaluationComponent.Range maps to component.value[x] ObservationTopic.EvaluationComponent.Ratio maps to component.value[x] ObservationTopic.EvaluationComponent.Media maps to component.value[x] ObservationTopic.EvaluationComponent.time maps to component.value[x] ObservationTopic.EvaluationComponent.dateTime maps to component.value[x] ObservationTopic.EvaluationComponent.TimePeriod maps to component.value[x] ObservationTopic.EvaluationComponent.IntegerQuantity maps to component.value[x] ObservationTopic.EvaluationComponent.ExceptionValue maps to component.dataAbsentReason ObservationTopic.EvaluationComponent.Interpretation maps to component.interpretation ObservationTopic.EvaluationComponent.ReferenceRange maps to component.referenceRange fix related.type to #has-member ObservationTopic.PanelMembers maps to related ObservationTopic.PanelMembers.Observation maps to related.target (slice at = related; slice on = target.reference.resolve(); slice on type = profile; slice strategy = includes) ObservationContext.ResultValue maps to value[x] ObservationContext.ExceptionValue maps to dataAbsentReason ObservationContext.Interpretation maps to interpretation ObservationContext.Issued maps to issued ObservationContext.FindingStatus maps to status ObservationContext.RelevantTime maps to effective[x] ObservationContext.DeltaFlag maps to http://hl7.org/fhir/StructureDefinition/observation-delta
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | BC ComponentOnlyNonLaboratoryObservation Profile | |||
| observation-delta | 0..1 | CodeableConcept | Qualitative change or trend in the measurement URL: http://hl7.org/fhir/StructureDefinition/observation-delta | |
| category | Binding: Observation Category Codes (extensible) | |||
| value[x] | 0..0 | |||
| dataAbsentReason | 0..0 | |||
| bodySite | Binding: BC AnatomicalLocationVS ValueSet (required) | |||
| method | Binding: http://loinc.org/vs (preferred) | |||
| specimen | 0..0 | |||
| device | Reference(US Core Device Profile) | |||
| referenceRange | 0..0 | |||
| related | 0..0 | |||
| component | ||||
| value[x] | Quantity, CodeableConcept, string, Range, RatioProfile, Attachment, time, dateTime, Period | |||
| dataAbsentReason | Binding: DataAbsentReason (extensible) | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | BC ComponentOnlyNonLaboratoryObservation Profile us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present | |
| 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 |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 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 Slice: Unordered, Open by value:url | |
| observation-delta | 0..1 | CodeableConcept | Qualitative change or trend in the measurement URL: http://hl7.org/fhir/StructureDefinition/observation-delta | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for observation |
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) | Fulfills plan, proposal or order |
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
| category | SI | 1..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (extensible) us-core-5: Must have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category' |
| code | SΣ | 1..1 | CodeableConcept | Laboratory Test Name Binding: LOINC Codes (extensible) |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who and/or what this is about |
| context | 0..1 | Reference(Encounter | EpisodeOfCare) | Healthcare event during which this observation is made | |
| effective[x] | SΣI | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation us-core-1: Datetime must be at least to day. |
| issued | Σ | 0..1 | instant | Date/Time this was made available |
| performer | Σ | 0..* | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
| comment | 0..1 | string | Comments about result | |
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: BC AnatomicalLocationVS ValueSet (required) | |
| method | 0..1 | CodeableConcept | How it was done Binding: http://loinc.org/vs (preferred) | |
| device | 0..1 | Reference(US Core Device Profile) | (Measurement) Device | |
| component | ΣI | 0..* | BackboneElement | Component results |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
| value[x] | Σ | 0..1 | Quantity, CodeableConcept, string, Range, RatioProfile, Attachment, time, dateTime, Period | Actual component result |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
| referenceRange | 0..* | BackboneElement | Provides guide for interpretation of component result | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | I | 0..1 | SimpleQuantity | High Range, if relevant |
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (extensible) | |
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) | |
| age | 0..1 | Range | Applicable age range, if relevant | |
| text | 0..1 | string | Text based reference range in an observation | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Name | Conformance | ValueSet |
| Observation.language | Common Languages | extensible | Common Languages |
| Observation.status | ObservationStatus | required | ObservationStatus |
| Observation.category | Observation Category Codes | extensible | Observation Category Codes |
| Observation.code | LOINC Codes | extensible | LOINC Codes |
| Observation.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
| Observation.bodySite | BC AnatomicalLocationVS ValueSet | required | AnatomicalLocationVS |
| Observation.method | ?ext | preferred | http://loinc.org/vs |
| Observation.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
| Observation.referenceRange.appliesTo | Observation Reference Range Applies To Codes | extensible | Observation Reference Range Applies To Codes |
| Observation.related.type | ObservationRelationshipType | required | ObservationRelationshipType |
| Observation.component.code | LOINC Codes | example | LOINC Codes |
| Observation.component.dataAbsentReason | DataAbsentReason | extensible | DataAbsentReason |
| Observation.component.interpretation | Observation Interpretation Codes | extensible | Observation Interpretation Codes |
| Observation.component.referenceRange.type | Observation Reference Range Meaning Codes | extensible | Observation Reference Range Meaning Codes |
| Observation.component.referenceRange.appliesTo | Observation Reference Range Applies To Codes | example | Observation Reference Range Applies To Codes |
| Id | Path | Details | Requirements |
| dom-2 | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Observation | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Observation | If 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-3 | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| obs-7 | Observation | If code is the same as a component code then the value element associated with the code SHALL NOT be present : value.empty() or code!=component.code | |
| obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| us-core-2 | Observation | If there is no component or related element then either a value[x] or a data absent reason must be present : (component.empty() and related.empty()) implies (dataAbsentReason or value) | |
| us-core-5 | Observation.category | Must have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category' : where(coding.system='http://hl7.org/fhir/observation-category' and coding.code='laboratory').exists() | |
| us-core-1 | Observation.effective[x] | Datetime must be at least to day. : ($this as dateTime).toString().length() >= 8 | |
| ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |