International Patient Summary Implementation Guide Implementation Guide Release 0.1.0

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:

Slices

This structure defines the following Slices:

  • The element Observation.related is sliced based on the value of value:type

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation Laboratory result for a simple test or for a panel/study
... basedOn ..0
... status Fixed Value: final
... category 1..1CodeableConcept-uv-ips
... code SCodeableConcept-uv-ipsBinding: ips-laboratory-tests-and-panels (extensible)
... subject S1..Reference(Patient)
.... identifier ..0
... effective[x] S1..
... performer S1..1Reference(Practitioner | Patient | Organization (laboratory))
.... identifier ..0
... value[x] SIstring, Range, Ratio, time, dateTime, Period, CodeableConcept-uv-ips, quantity-uv-ipsBinding: 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 S1..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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*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 ΣI0..1idLogical id of this artifact
ele-1: All FHIR elements must have a @value or children
... meta ΣI0..1MetaMetadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language I0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
ele-1: All FHIR elements must have a @value or children
... text I0..1NarrativeText summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... contained 0..*ResourceContained, inline Resources
... identifier ΣI0..*IdentifierBusiness Identifier for observation
ele-1: All FHIR elements must have a @value or children
... status ?!ΣI1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
ele-1: All FHIR elements must have a @value or children
Fixed Value: final
... category I1..1CodeableConcept-uv-ipsConcept - 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ΣI0..*CodeableConcept-uv-ipsConcept - 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ΣI1..1Reference(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 I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
.... display ΣI0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children
... context I0..1Reference(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 I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
.... display ΣI0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children
... effective[x] SΣI1..1dateTime, PeriodClinically relevant time/time-period for observation
ele-1: All FHIR elements must have a @value or children
... issued ΣI0..1instantDate/Time this was made available
ele-1: All FHIR elements must have a @value or children
... performer SΣI1..1Reference(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 I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
.... display ΣI0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children
... value[x] SΣI0..1string, Range, Ratio, time, dateTime, Period, CodeableConcept-uv-ips, quantity-uv-ipsActual 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 I0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... coding ΣI0..*coding-uv-ipsA reference to a code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
..... system ΣI0..1uriIdentity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... version ΣI0..1stringVersion of the system - if relevant
ele-1: All FHIR elements must have a @value or children
..... code ΣI0..1codeSymbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display ΣI0..1stringRepresentation defined by the system
ele-1: All FHIR elements must have a @value or children
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
ele-1: All FHIR elements must have a @value or children
.... text ΣI0..1stringPlain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... comment I0..1stringComments about result
ele-1: All FHIR elements must have a @value or children
... method I0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... coding ΣI0..*coding-uv-ipsA reference to a code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
..... system ΣI0..1uriIdentity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... version ΣI0..1stringVersion of the system - if relevant
ele-1: All FHIR elements must have a @value or children
..... code ΣI0..1codeSymbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display ΣI0..1stringRepresentation defined by the system
ele-1: All FHIR elements must have a @value or children
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
ele-1: All FHIR elements must have a @value or children
.... text ΣI0..1stringPlain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... specimen I0..1Reference(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 I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
.... display ΣI0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children
... device I0..1Reference(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 I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
.... display ΣI0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children
... referenceRange I0..*BackboneElementProvides 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 I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!ΣI0..*ExtensionExtensions 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 I0..1SimpleQuantityLow 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 I0..1SimpleQuantityHigh 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 SI1..*CodeableConcept-uv-ipsConcept - 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 I0..*CodeableConceptReference range population
Binding: Observation Reference Range Applies To Codes (example)
ele-1: All FHIR elements must have a @value or children
.... age I0..1RangeApplicable 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 I0..1stringText based reference range in an observation
ele-1: All FHIR elements must have a @value or children
... related ΣIBackboneElementResource related to this observation
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!ΣI0..*ExtensionExtensions 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 I1..1codehas-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 I1..1Reference(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 ΣI0..*BackboneElementsub-observation member of this observation
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!ΣI0..*ExtensionExtensions 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 SI1..1codehas-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 I1..1Reference(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 ΣI0..*BackboneElementattachment associated to this observation
ele-1: All FHIR elements must have a @value or children
.... id I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!ΣI0..*ExtensionExtensions 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 I1..1codehas-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 I1..1Reference(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 I0..1stringxml:id (or equivalent in JSON)
ele-1: All FHIR elements must have a @value or children
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
..... display ΣI0..1stringText alternative for the resource
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron