This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
SD.22 StructureDefinition-observation-pathology-uv-ips
This profile constrains the Observation resource to represent results produced by pathology studies in a patient summary
Conformance resource variables defined here
SD.22.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/observation-pathology-uv-ips
Published on Wed Mar 21 00:00:00 AEDT 2018 as a draft by HL7 International.
This profile builds on Observation
Summary
Mandatory: 0 element (8 nested mandatory elements)
Must-Support: 7 elements
Fixed Value: 4 elements
Prohibited: 10 elements
Structures
This structure refers to these other structures:
- http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips
- http://hl7.org/fhir/uv/ips/StructureDefinition/quantity-uv-ips
- http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips
- http://hl7.org/fhir/uv/ips/StructureDefinition/specimen-uv-ips
- http://hl7.org/fhir/uv/ips/StructureDefinition/observation-member-pathology-uv-ips
- http://hl7.org/fhir/uv/ips/StructureDefinition/observation-attachment-uv-ips
Slices
This structure defines the following Slices:
- The element Observation.related is sliced based on the value of value:type
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | Laboratory result for a simple test or for a panel/study | |||
basedOn | ..0 | |||
status | Fixed Value: final | |||
category | 1..1 | CodeableConcept-uv-ips | ||
code | S | CodeableConcept-uv-ips | Binding: ips-laboratory-tests-and-panels (extensible) | |
subject | S | 1.. | Reference(Patient) | |
identifier | ..0 | |||
effective[x] | S | 1.. | ||
performer | S | 1..1 | Reference(Practitioner | Patient | Organization (laboratory)) | |
identifier | ..0 | |||
value[x] | SI | string, Range, Ratio, time, dateTime, Period, CodeableConcept-uv-ips, quantity-uv-ips | Binding: IPSLabResultsCodedValues (extensible) val-1: if no "related" element is present then Observation must have a" value" | |
dataAbsentReason | ..0 | |||
bodySite | ..0 | |||
specimen | Reference(Specimen) | |||
identifier | ..0 | |||
related | Slice: Unordered, Open by value:type | |||
type | 1.. | has-member: the related observation is a sub-observation of the current one, which acts as a grouper Fixed Value: has-member | ||
related | sub-observation member of this observation | |||
type | S | 1.. | Fixed Value: has-member | |
target | Reference(Observation (member pathology)) | |||
related | attachment associated to this observation | |||
type | 1.. | Fixed Value: derived-from | ||
target | Reference(Observation (attachment)) | |||
identifier | ..0 | |||
component | ..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Laboratory result for a simple test or for a panel/study dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present | |
id | ΣI | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
meta | ΣI | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) ele-1: All FHIR elements must have a @value or children |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
contained | 0..* | Resource | Contained, inline Resources | |
identifier | ΣI | 0..* | Identifier | Business Identifier for observation ele-1: All FHIR elements must have a @value or children |
status | ?!ΣI | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) ele-1: All FHIR elements must have a @value or children Fixed Value: final |
category | I | 1..1 | CodeableConcept-uv-ips | Concept - reference to a terminology or just text Binding: Observation Category Codes (preferred) ele-1: All FHIR elements must have a @value or children |
code | SΣI | 0..* | CodeableConcept-uv-ips | Concept - reference to a terminology or just text Binding: ips-laboratory-tests-and-panels (extensible) ele-1: All FHIR elements must have a @value or children |
subject | SΣI | 1..1 | Reference(Patient) | Who and/or what this is about ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
context | I | 0..1 | Reference(Encounter | EpisodeOfCare) | Healthcare event during which this observation is made ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
effective[x] | SΣI | 1..1 | dateTime, Period | Clinically relevant time/time-period for observation ele-1: All FHIR elements must have a @value or children |
issued | ΣI | 0..1 | instant | Date/Time this was made available ele-1: All FHIR elements must have a @value or children |
performer | SΣI | 1..1 | Reference(Practitioner | Patient | Organization (laboratory)) | Who is responsible for the observation ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
value[x] | SΣI | 0..1 | string, Range, Ratio, time, dateTime, Period, CodeableConcept-uv-ips, quantity-uv-ips | Actual result Binding: IPSLabResultsCodedValues (extensible) ele-1: All FHIR elements must have a @value or children qty-3: If a code for the unit is present, the system SHALL also be present val-1: if no "related" element is present then Observation must have a" value" |
interpretation | I | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) ele-1: All FHIR elements must have a @value or children |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
coding | ΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
comment | I | 0..1 | string | Comments about result ele-1: All FHIR elements must have a @value or children |
method | I | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) ele-1: All FHIR elements must have a @value or children |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
coding | ΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
specimen | I | 0..1 | Reference(Specimen) | Specimen used for this observation ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
device | I | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation ele-1: All FHIR elements must have a @value or children obs-3: Must have at least a low or a high or text |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant ele-1: All FHIR elements must have a @value or children qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
high | I | 0..1 | SimpleQuantity | High Range, if relevant ele-1: All FHIR elements must have a @value or children qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
type | SI | 1..* | CodeableConcept-uv-ips | Concept - reference to a terminology or just text Binding: Observation Reference Range Meaning Codes (extensible) ele-1: All FHIR elements must have a @value or children |
appliesTo | I | 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (example) ele-1: All FHIR elements must have a @value or children |
age | I | 0..1 | Range | Applicable age range, if relevant ele-1: All FHIR elements must have a @value or children rng-2: If present, low SHALL have a lower value than high |
text | I | 0..1 | string | Text based reference range in an observation ele-1: All FHIR elements must have a @value or children |
related | ΣI | BackboneElement | Resource related to this observation Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children | |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
type | I | 1..1 | code | has-member: the related observation is a sub-observation of the current one, which acts as a grouper Binding: ObservationRelationshipType (required) ele-1: All FHIR elements must have a @value or children Fixed Value: has-member |
target | I | 1..1 | Reference(Observation | QuestionnaireResponse | Sequence) | Resource that is related to this one ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
related | ΣI | 0..* | BackboneElement | sub-observation member of this observation ele-1: All FHIR elements must have a @value or children |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
type | SI | 1..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) ele-1: All FHIR elements must have a @value or children Fixed Value: has-member |
target | I | 1..1 | Reference(Observation (member pathology)) | Resource that is related to this one ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
related | ΣI | 0..* | BackboneElement | attachment associated to this observation ele-1: All FHIR elements must have a @value or children |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
type | I | 1..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) ele-1: All FHIR elements must have a @value or children Fixed Value: derived-from |
target | I | 1..1 | Reference(Observation (attachment)) | Resource that is related to this one ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron