STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

H.?? StructureDefinition: hspc-std

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/hspc-std

StandardLabObs is the base Model for standard laboratory test results/observations such as hematology, chemistry, coagulation, serology and blood bank. This model will not be used for microbiology nor anatomic pathology data

This profile was published on Wed, Feb 18, 2015 00:00+1100 as a draft by HSPC.

H.??.1 Formal Views of Profile Content

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

This structure is derived from Observation.

Summary

Mandatory: 1 element
Prohibited: 5 elements

Structures

This structure refers to these other structures:

  • unable to summarise profile http://hl7.org/fhir/StructureDefinition/hspc-responsibleobserver (no profile found)
  • unable to summarise profile http://hl7.org/fhir/StructureDefinition/hspc-performinglaboratory (no profile found)
  • unable to summarise profile http://hl7.org/fhir/StructureDefinition/hspc-specimen (no profile found)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.performer is sliced based on the value of performer.type (ordered, Closed)

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*Observation
... applies[x] 0..0
... identifier 0..0
... code 1..1CodeableConcept
... subject 1..1Reference(Patient | Group | Device | Location)
... issued 0..1instant
... performer Reference(Practitioner | Organization | Patient | RelatedPerson)Slice: Ordered, Closed, by performer.type
... performer 0..*Reference(hspc-responsibleobserver)the individual with the primary responsibility for the procedure or action being taken
... performer 0..1Reference(hspc-performinglaboratory)name and address of the laboratory that performs the test
... interpretation 0..1CodeableConceptBinding: Ordinal Assessment or Interpretation (preferred)
... comment 0..1string
... bodySite 0..0
... method 0..0
... specimen 0..1Reference(hspc-specimen)
... related 0..0
... hspc-reporting-priority 0..1codeUrgency Level for result
URL: http://hl7.org/fhir/StructureDefinition/hspc-reporting-priority
... hspc-delta-flag 0..1codeIndicate the data value in the containing model is a change from a previous instance of the same model
URL: http://hl7.org/fhir/StructureDefinition/hspc-delta-flag
... hspc-verified 0..1booleanWhether the information has been verified with the source
URL: http://hl7.org/fhir/StructureDefinition/hspc-verified
... hspc-updated 0..1dateTimeWhen this information was last updated
URL: http://hl7.org/fhir/StructureDefinition/hspc-updated

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-reporting-priority 0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-reporting-priority
... hspc-delta-flag 0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-delta-flag
... hspc-verified 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-verified
... hspc-updated 0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-updated
... observation-focal-subject ?!0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/observation-focal-subject
... status ?! ∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code ∑1..1CodeableConceptType of observation (code / type)
Binding: LOINC Codes (example)
... subject ∑1..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued ∑0..1instantDate/Time this was made available
... performer ∑Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
Slice: Ordered, Closed, by performer.type
... performer ∑0..*Reference(hspc-responsibleobserver)the individual with the primary responsibility for the procedure or action being taken
... performer ∑0..1Reference(hspc-performinglaboratory)name and address of the laboratory that performs the test
... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual result
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Ordinal Assessment or Interpretation (preferred)
... comment 0..1stringComments about result
... specimen 0..1Reference(hspc-specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

todo

This structure is derived from Observation.

Summary

Mandatory: 1 element
Prohibited: 5 elements

Structures

This structure refers to these other structures:

  • unable to summarise profile http://hl7.org/fhir/StructureDefinition/hspc-responsibleobserver (no profile found)
  • unable to summarise profile http://hl7.org/fhir/StructureDefinition/hspc-performinglaboratory (no profile found)
  • unable to summarise profile http://hl7.org/fhir/StructureDefinition/hspc-specimen (no profile found)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.performer is sliced based on the value of performer.type (ordered, Closed)

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*Observation
... applies[x] 0..0
... identifier 0..0
... code 1..1CodeableConcept
... subject 1..1Reference(Patient | Group | Device | Location)
... issued 0..1instant
... performer Reference(Practitioner | Organization | Patient | RelatedPerson)Slice: Ordered, Closed, by performer.type
... performer 0..*Reference(hspc-responsibleobserver)the individual with the primary responsibility for the procedure or action being taken
... performer 0..1Reference(hspc-performinglaboratory)name and address of the laboratory that performs the test
... interpretation 0..1CodeableConceptBinding: Ordinal Assessment or Interpretation (preferred)
... comment 0..1string
... bodySite 0..0
... method 0..0
... specimen 0..1Reference(hspc-specimen)
... related 0..0
... hspc-reporting-priority 0..1codeUrgency Level for result
URL: http://hl7.org/fhir/StructureDefinition/hspc-reporting-priority
... hspc-delta-flag 0..1codeIndicate the data value in the containing model is a change from a previous instance of the same model
URL: http://hl7.org/fhir/StructureDefinition/hspc-delta-flag
... hspc-verified 0..1booleanWhether the information has been verified with the source
URL: http://hl7.org/fhir/StructureDefinition/hspc-verified
... hspc-updated 0..1dateTimeWhen this information was last updated
URL: http://hl7.org/fhir/StructureDefinition/hspc-updated

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-reporting-priority 0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-reporting-priority
... hspc-delta-flag 0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-delta-flag
... hspc-verified 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-verified
... hspc-updated 0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-updated
... observation-focal-subject ?!0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/observation-focal-subject
... status ?! ∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code ∑1..1CodeableConceptType of observation (code / type)
Binding: LOINC Codes (example)
... subject ∑1..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued ∑0..1instantDate/Time this was made available
... performer ∑Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
Slice: Ordered, Closed, by performer.type
... performer ∑0..*Reference(hspc-responsibleobserver)the individual with the primary responsibility for the procedure or action being taken
... performer ∑0..1Reference(hspc-performinglaboratory)name and address of the laboratory that performs the test
... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual result
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Ordinal Assessment or Interpretation (preferred)
... comment 0..1stringComments about result
... specimen 0..1Reference(hspc-specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

H.??.2 Terminology Bindings

PathNameConformanceValueSet
Observation.language?extrequiredhttp://tools.ietf.org/html/bcp47
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeLOINC CodesexampleLOINC Codes
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationOrdinal Assessment or InterpretationpreferredOrdinal Assessment or Interpretation
Observation.referenceRange.meaningObservation Reference Range Meaning CodesexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason

H.??.3 Constraints

IdPathDetailsRequirements
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-7ObservationComponent code SHALL not be same as observation code
XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0
obs-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
.