Breast Radiology Reporting - 1st STU ballot - Local Development build (v0.2.0). See the Directory of published versions
Foreign Object Observation
This resource and referenced child resources contain information about foreign objects observed
A foreign object is some non-biological item observed in the patient. These can include misplaced surgical items, trauma related items (bullet fragments), or jewelery.
The official URL for this profile is:
http://hl7.org/fhir/us/breast-radiology/StructureDefinition/AbnormalityForeignObject
Graphical Overview
This graph provides an overview of:
Click on any of the elements of the graph to go to a section describing that element.
Member Fields
The following parts of this observation are contained within this resource.
Each field contains one data item and is stored as an item (slice) in the Observation.component element.
Member Observations
The following parts of this observation are stored in seperate observation resources.
The reference to each external observation is stored as an item in the Observation.hasMember element.
Profile Fragments
The following are the fragments that are included in this profile.
This section is included primarily for developers to understand the hierarchy and commonality of each profile.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Summary
Mandatory: 8 elements (10 nested mandatory elements)
Prohibited: 11 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Foreign Object Observation | |
contained | 0..0 | |||
basedOn | 0..0 | |||
partOf | 0..0 | |||
category | 1..* | (Slice Definition) | Classification of type of observation Slice: Unordered, Open by type:$this | |
category:categoryImaging | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imaging | |
code | 1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: abnormalityForeignObjectObservation | |
focus | 0..0 | |||
value[x] | 0..0 | |||
dataAbsentReason | 0..0 | |||
interpretation | 0..0 | |||
bodySite | 1..1 | CodeableConcept | Observed body part | |
extension | 0..* | Extension | Extension Slice: Ordered, Open At End by value:url | |
BreastBodyLocationExtension | 1..1 | (Complex) | breastBodyLocation extension. URL: http://hl7.org/fhir/us/breast-radiology/StructureDefinition/BreastBodyLocationExtension | |
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | 0..* | (Slice Definition) | Related resource that belongs to the Observation group Slice: Ordered, Open At End by value:url | |
hasMember:associatedFeature | 0..* | Reference(Associated Feature) | 'Associated Feature' reference. | |
hasMember:consistentWith | 0..* | Reference(Consistent With) | 'Consistent With' reference. | |
component | 0..0 | (Slice Definition) | ||
component:abnormalityForeignObjectType | ΣI | 1..1 | BackboneElement | Foreign Object Type component. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | CodeableConcept | Foreign Object Type component code Binding: LOINCCodes (example) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: abnormalityForeignObjectType | |
value[x] | Σ | 1..1 | CodeableConcept | Foreign Object Type component value Binding: Foreign Object ValueSet (required) |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
component:obsChanges | 0..* | BackboneElement | Observed Change In Abnormality component. | |
code | 1..1 | CodeableConcept | Observed Change In Abnormality component code Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: obsChanges | |
value[x] | 1..1 | CodeableConcept | Observed Change In Abnormality component value Binding: Observed Changes ValueSet (required) | |
component:biRadsAssessmentCategory | 0..1 | BackboneElement | BiRads Assessment Category component. | |
code | 1..1 | CodeableConcept | BiRads Assessment Category component code Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: targetBiRads | |
value[x] | 1..1 | CodeableConcept | BiRads Assessment Category component value Binding: BiRads(r) Assessment Category ValueSet (required) | |
component:notPreviouslySeen | ΣI | 0..* | BackboneElement | Not Previously Seen component. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | CodeableConcept | Not Previously Seen component code Binding: LOINCCodes (example) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notPreviouslySeen | |
value[x] | Σ | 1..1 | CodeableConcept | Not Previously Seen component value Binding: NotPreviouslySeen ValueSet (required) |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
component:correspondsWith | 0..* | BackboneElement | Corresponds With component. | |
code | 1..1 | CodeableConcept | Corresponds With component code Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: correspondsWith | |
value[x] | 1..1 | CodeableConcept | Corresponds With component value Binding: CorrespondsWith ValueSet (extensible) | |
component:PreviouslyDemonstratedBy | 0..* | BackboneElement | Previously Demonstrated By component. | |
code | 1..1 | CodeableConcept | Previously Demonstrated By component code Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: prevDemBy | |
value[x] | 1..1 | CodeableConcept | Previously Demonstrated By component value Binding: PreviouslyDemonstratedBy ValueSet (extensible) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Foreign Object Observation |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Business Identifier for observation |
status | ?!ΣI | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | I | 1..* | (Slice Definition) | Classification of type of observation Slice: Unordered, Open by type:$this Binding: ObservationCategoryCodes (preferred) |
category:categoryImaging | I | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred) Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imaging | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
code | ΣI | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationCodes | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: abnormalityForeignObjectObservation | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
subject | ΣI | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
encounter | ΣI | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
effective[x] | ΣI | 0..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
issued | ΣI | 0..1 | instant | Date/Time this version was made available |
performer | ΣI | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
note | I | 0..* | Annotation | Comments about the observation |
bodySite | I | 1..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Extension Slice: Ordered, Open At End by value:url |
BreastBodyLocationExtension | I | 1..1 | (Complex) | breastBodyLocation extension. URL: http://hl7.org/fhir/us/breast-radiology/StructureDefinition/BreastBodyLocationExtension |
coding | ΣI | 0..* | Coding | Code defined by a terminology system |
text | ΣI | 0..1 | string | Plain text representation of the concept |
method | I | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example) |
hasMember | ΣI | 0..* | (Slice Definition) | Related resource that belongs to the Observation group Slice: Ordered, Open At End by value:url |
hasMember:associatedFeature | ΣI | 0..* | Reference(Associated Feature) | 'Associated Feature' reference. |
hasMember:consistentWith | ΣI | 0..* | Reference(Consistent With) | 'Consistent With' reference. |
derivedFrom | ΣI | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
Documentation for this format |
This structure is derived from Observation
Summary
Mandatory: 8 elements (10 nested mandatory elements)
Prohibited: 11 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Foreign Object Observation | |
contained | 0..0 | |||
basedOn | 0..0 | |||
partOf | 0..0 | |||
category | 1..* | (Slice Definition) | Classification of type of observation Slice: Unordered, Open by type:$this | |
category:categoryImaging | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imaging | |
code | 1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: abnormalityForeignObjectObservation | |
focus | 0..0 | |||
value[x] | 0..0 | |||
dataAbsentReason | 0..0 | |||
interpretation | 0..0 | |||
bodySite | 1..1 | CodeableConcept | Observed body part | |
extension | 0..* | Extension | Extension Slice: Ordered, Open At End by value:url | |
BreastBodyLocationExtension | 1..1 | (Complex) | breastBodyLocation extension. URL: http://hl7.org/fhir/us/breast-radiology/StructureDefinition/BreastBodyLocationExtension | |
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | 0..* | (Slice Definition) | Related resource that belongs to the Observation group Slice: Ordered, Open At End by value:url | |
hasMember:associatedFeature | 0..* | Reference(Associated Feature) | 'Associated Feature' reference. | |
hasMember:consistentWith | 0..* | Reference(Consistent With) | 'Consistent With' reference. | |
component | 0..0 | (Slice Definition) | ||
component:abnormalityForeignObjectType | ΣI | 1..1 | BackboneElement | Foreign Object Type component. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | CodeableConcept | Foreign Object Type component code Binding: LOINCCodes (example) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: abnormalityForeignObjectType | |
value[x] | Σ | 1..1 | CodeableConcept | Foreign Object Type component value Binding: Foreign Object ValueSet (required) |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
component:obsChanges | 0..* | BackboneElement | Observed Change In Abnormality component. | |
code | 1..1 | CodeableConcept | Observed Change In Abnormality component code Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: obsChanges | |
value[x] | 1..1 | CodeableConcept | Observed Change In Abnormality component value Binding: Observed Changes ValueSet (required) | |
component:biRadsAssessmentCategory | 0..1 | BackboneElement | BiRads Assessment Category component. | |
code | 1..1 | CodeableConcept | BiRads Assessment Category component code Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: targetBiRads | |
value[x] | 1..1 | CodeableConcept | BiRads Assessment Category component value Binding: BiRads(r) Assessment Category ValueSet (required) | |
component:notPreviouslySeen | ΣI | 0..* | BackboneElement | Not Previously Seen component. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | CodeableConcept | Not Previously Seen component code Binding: LOINCCodes (example) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notPreviouslySeen | |
value[x] | Σ | 1..1 | CodeableConcept | Not Previously Seen component value Binding: NotPreviouslySeen ValueSet (required) |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
component:correspondsWith | 0..* | BackboneElement | Corresponds With component. | |
code | 1..1 | CodeableConcept | Corresponds With component code Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: correspondsWith | |
value[x] | 1..1 | CodeableConcept | Corresponds With component value Binding: CorrespondsWith ValueSet (extensible) | |
component:PreviouslyDemonstratedBy | 0..* | BackboneElement | Previously Demonstrated By component. | |
code | 1..1 | CodeableConcept | Previously Demonstrated By component code Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationComponentSliceCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: prevDemBy | |
value[x] | 1..1 | CodeableConcept | Previously Demonstrated By component value Binding: PreviouslyDemonstratedBy ValueSet (extensible) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Foreign Object Observation |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Business Identifier for observation |
status | ?!ΣI | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | I | 1..* | (Slice Definition) | Classification of type of observation Slice: Unordered, Open by type:$this Binding: ObservationCategoryCodes (preferred) |
category:categoryImaging | I | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred) Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imaging | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
code | ΣI | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/breast-radiology/CodeSystem/ObservationCodes | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: abnormalityForeignObjectObservation | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
subject | ΣI | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
encounter | ΣI | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
effective[x] | ΣI | 0..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
issued | ΣI | 0..1 | instant | Date/Time this version was made available |
performer | ΣI | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
note | I | 0..* | Annotation | Comments about the observation |
bodySite | I | 1..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Extension Slice: Ordered, Open At End by value:url |
BreastBodyLocationExtension | I | 1..1 | (Complex) | breastBodyLocation extension. URL: http://hl7.org/fhir/us/breast-radiology/StructureDefinition/BreastBodyLocationExtension |
coding | ΣI | 0..* | Coding | Code defined by a terminology system |
text | ΣI | 0..1 | string | Plain text representation of the concept |
method | I | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example) |
hasMember | ΣI | 0..* | (Slice Definition) | Related resource that belongs to the Observation group Slice: Ordered, Open At End by value:url |
hasMember:associatedFeature | ΣI | 0..* | Reference(Associated Feature) | 'Associated Feature' reference. |
hasMember:consistentWith | ΣI | 0..* | Reference(Consistent With) | 'Consistent With' reference. |
derivedFrom | ΣI | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
Observation.language | preferred | CommonLanguages Max Binding: AllLanguages |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:categoryImaging | preferred | Pattern: imaging |
Observation.code | example | Pattern: abnormalityForeignObjectObservation |
Observation.bodySite | example | SNOMEDCTBodyStructures |
Observation.method | example | ObservationMethods |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
Observation.component.code | example | LOINCCodes |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
Observation.component:abnormalityForeignObjectType.code | example | Pattern: abnormalityForeignObjectType |
Observation.component:abnormalityForeignObjectType.value[x] | required | ForeignObjectVS |
Observation.component:abnormalityForeignObjectType.dataAbsentReason | extensible | DataAbsentReason |
Observation.component:abnormalityForeignObjectType.interpretation | extensible | ObservationInterpretationCodes |
Observation.component:obsChanges.code | example | Pattern: obsChanges |
Observation.component:obsChanges.value[x] | required | ObservedChangesVS |
Observation.component:obsChanges.dataAbsentReason | extensible | DataAbsentReason |
Observation.component:obsChanges.interpretation | extensible | ObservationInterpretationCodes |
Observation.component:biRadsAssessmentCategory.code | example | Pattern: targetBiRads |
Observation.component:biRadsAssessmentCategory.value[x] | required | BiRadsAssessmentCategoriesVS |
Observation.component:biRadsAssessmentCategory.dataAbsentReason | extensible | DataAbsentReason |
Observation.component:biRadsAssessmentCategory.interpretation | extensible | ObservationInterpretationCodes |
Observation.component:notPreviouslySeen.code | example | Pattern: notPreviouslySeen |
Observation.component:notPreviouslySeen.value[x] | required | NotPreviouslySeenVS |
Observation.component:notPreviouslySeen.dataAbsentReason | extensible | DataAbsentReason |
Observation.component:notPreviouslySeen.interpretation | extensible | ObservationInterpretationCodes |
Observation.component:correspondsWith.code | example | Pattern: correspondsWith |
Observation.component:correspondsWith.value[x] | extensible | CorrespondsWithVS |
Observation.component:correspondsWith.dataAbsentReason | extensible | DataAbsentReason |
Observation.component:correspondsWith.interpretation | extensible | ObservationInterpretationCodes |
Observation.component:PreviouslyDemonstratedBy.code | example | Pattern: prevDemBy |
Observation.component:PreviouslyDemonstratedBy.value[x] | extensible | PreviouslyDemonstratedByVS |
Observation.component:PreviouslyDemonstratedBy.dataAbsentReason | extensible | DataAbsentReason |
Observation.component:PreviouslyDemonstratedBy.interpretation | extensible | ObservationInterpretationCodes |
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-3 | Observation | If 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-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-5 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() | |
ele-1 | Observation.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.category:categoryImaging | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.effective[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.issued | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.bodySite.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.bodySite.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.bodySite.extension:breastBodyLocation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.bodySite.extension:breastBodyLocation | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.bodySite.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.bodySite.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.referenceRange.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.referenceRange.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.referenceRange.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.referenceRange.low | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.high | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.appliesTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.age | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.referenceRange.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.hasMember | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.hasMember:associatedFeature | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.hasMember:consistentWith | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.derivedFrom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.interpretation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:abnormalityForeignObjectType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:abnormalityForeignObjectType.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:abnormalityForeignObjectType.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:abnormalityForeignObjectType.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:abnormalityForeignObjectType.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:abnormalityForeignObjectType.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:abnormalityForeignObjectType.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:abnormalityForeignObjectType.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:abnormalityForeignObjectType.interpretation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:abnormalityForeignObjectType.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:obsChanges | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:obsChanges.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:obsChanges.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:obsChanges.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:obsChanges.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:obsChanges.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:obsChanges.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:obsChanges.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:obsChanges.interpretation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:obsChanges.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:biRadsAssessmentCategory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:biRadsAssessmentCategory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:biRadsAssessmentCategory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:biRadsAssessmentCategory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:biRadsAssessmentCategory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:biRadsAssessmentCategory.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:biRadsAssessmentCategory.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:biRadsAssessmentCategory.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:biRadsAssessmentCategory.interpretation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:biRadsAssessmentCategory.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:notPreviouslySeen | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:notPreviouslySeen.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:notPreviouslySeen.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:notPreviouslySeen.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:notPreviouslySeen.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:notPreviouslySeen.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:notPreviouslySeen.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:notPreviouslySeen.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:notPreviouslySeen.interpretation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:notPreviouslySeen.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:correspondsWith | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:correspondsWith.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:correspondsWith.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:correspondsWith.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:correspondsWith.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:correspondsWith.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:correspondsWith.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:correspondsWith.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:correspondsWith.interpretation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:correspondsWith.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:PreviouslyDemonstratedBy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:PreviouslyDemonstratedBy.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:PreviouslyDemonstratedBy.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:PreviouslyDemonstratedBy.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Observation.component:PreviouslyDemonstratedBy.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Observation.component:PreviouslyDemonstratedBy.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:PreviouslyDemonstratedBy.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:PreviouslyDemonstratedBy.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:PreviouslyDemonstratedBy.interpretation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Observation.component:PreviouslyDemonstratedBy.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |