US Core Implementation Guide
8.0.0-ballot - STU8 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Observation Occupation Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-occupation Version: 8.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: USCoreObservationOccupationProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.43

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The US Core Observation Occupation Profile inherits from the FHIR Observation resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Occupation and Occupation Industry Data Elements. It sets minimum expectations for the Observation resource to record, search, and fetch a patient's past or present job as occupation and industry, in other words, the type of work and type of business that compensates for work or assigns work to an unpaid worker or volunteer. In the context of this profile, a job is defined as a work situation or a training or volunteer position held for a specified period. This profile specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query for a patient's work history
  • Record or update past or present jobs belonging to a patient

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Observation Must Have:

  1. a status
  2. a code for job history
  3. a patient
  4. the job code or text

Each Observation Must Support:

  1. a category code of "social-history"
  2. when the job occurred
  3. a code for the job history industry
  4. the industry code or text

Profile Specific Implementation Guidance:

  • Additional codes that translate or map to the Observation code or category codes are allowed. For example:
    • providing both a local code and a LOINC code
    • providing a more specific code, a SNOMED CT concept, or a system-specific code
  • For the current job, omit observation.effectivePeriod.end to indicate it is ongoing.
  • When the industry is known, but the occupation is not, use the value "unknown" from the DataAbsentReason Code System. However, when the occupation is known but the industry is not, omit the industry Observation.component. The guide provides examples for both scenarios.
  • In the Quick Start section below, you can find instructions on searching for Occupations (Jobs) by patient, date, and other core search parameters. Refer to the FHIR search specification for more advanced queries using Observation.
  • Refer to the Occupational Data for Health (ODH) FHIR IG to convey additional details; data elements, such as Employer; or different topics, such as Usual (Longest-Held) Work.

Usage:

Changes since version 7.0.0:

  • No changes

    • Formal Views of Profile Content

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

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Observation 0..* Observation Past Or Present Occupation
    ... status S 1..1 code registered | preliminary | final | amended +
    ... Slices for category S 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    .... category:socialhistory S 0..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: social-history
    ... code S 1..1 CodeableConcept Occupation history
    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://loinc.org
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 11341-5
    ... subject S 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    ... effectivePeriod S 0..1 Period Clinically relevant time/time-period for observation
    ... valueCodeableConcept S 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health

    ... Slices for component S 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code
    .... component:industry S 0..1 BackboneElement Occupation industry
    ..... code S 1..1 CodeableConcept Occupation industry history
    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://loinc.org
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 86188-0
    ..... valueCodeableConcept S 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health


    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Observation.valueCodeableConceptextensiblePHVS_Occupation_ONETSOC_Detail_ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901
    Observation.component:industry.valueCodeableConceptextensiblePHVS_Industry_NAICS_Detail _ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7900
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Observation C 0..* Observation Past Or Present Occupation
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?! 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
    ... status ?!SΣ 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.


    ele-1: All FHIR elements must have a @value or children
    ... Slices for category S 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


    ele-1: All FHIR elements must have a @value or children
    .... category:socialhistory S 0..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


    ele-1: All FHIR elements must have a @value or children

    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: social-history
    ... code SΣ 1..1 CodeableConcept Occupation history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    ele-1: All FHIR elements must have a @value or children
    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://loinc.org
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 11341-5
    ... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    ele-1: All FHIR elements must have a @value or children
    ... Slices for effective[x] Σ 0..1 Clinically relevant time/time-period for observation
    Slice: Unordered, Open by type:$this
    ele-1: All FHIR elements must have a @value or children
    .... effectiveDateTime dateTime
    .... effectivePeriod Period
    .... effectiveTiming Timing
    .... effectiveInstant instant
    .... effective[x]:effectivePeriod SΣ 0..1 Period Clinically relevant time/time-period for observation
    ele-1: All FHIR elements must have a @value or children
    ... Slices for value[x] ΣC 1..1 CodeableConcept Actual result
    Slice: Unordered, Closed by type:$this
    ele-1: All FHIR elements must have a @value or children
    .... value[x]:valueCodeableConcept SΣC 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health


    ele-1: All FHIR elements must have a @value or children
    ... Slices for component SΣ 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code
    ele-1: All FHIR elements must have a @value or children
    .... component:All Slices Content/Rules for all slices
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    ele-1: All FHIR elements must have a @value or children
    .... component:industry SΣ 0..1 BackboneElement Occupation industry
    ele-1: All FHIR elements must have a @value or children
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... code SΣ 1..1 CodeableConcept Occupation industry history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    ele-1: All FHIR elements must have a @value or children
    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://loinc.org
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 86188-0
    ..... value[x] SΣ 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health


    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Observation.statusrequiredObservationStatus
    http://hl7.org/fhir/ValueSet/observation-status|4.0.1
    from the FHIR Standard
    Observation.categorypreferredObservationCategoryCodes
    http://hl7.org/fhir/ValueSet/observation-category
    from the FHIR Standard
    Observation.category:socialhistorypreferredPattern: social-history
    http://hl7.org/fhir/ValueSet/observation-category
    from the FHIR Standard
    Observation.codeexamplePattern: LOINC Code 11341-5
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.value[x]:valueCodeableConceptextensiblePHVS_Occupation_ONETSOC_Detail_ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901
    Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.component:industry.codeexamplePattern: LOINC Code 86188-0
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.component:industry.value[x]extensiblePHVS_Industry_NAICS_Detail _ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7900
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Observation C 0..* Observation Past Or Present Occupation
    obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier Σ 0..* Identifier Business Identifier for observation
    ... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    ... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    ... status ?!SΣ 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.

    ... Slices for category S 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


    .... category:socialhistory S 0..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



    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: social-history
    ...... 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 SΣ 1..1 CodeableConcept Occupation history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    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://loinc.org
    ..... version 0..1 string Version of the system - if relevant
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 11341-5
    ..... 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 SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    ... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    ... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
    ... Slices for effective[x] Σ 0..1 Clinically relevant time/time-period for observation
    Slice: Unordered, Open by type:$this
    .... effectiveDateTime dateTime
    .... effectivePeriod Period
    .... effectiveTiming Timing
    .... effectiveInstant instant
    .... effective[x]:effectivePeriod SΣ 0..1 Period Clinically relevant time/time-period for observation
    ... issued Σ 0..1 instant Date/Time this version was made available
    ... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
    ... Slices for value[x] ΣC 1..1 CodeableConcept Actual result
    Slice: Unordered, Closed by type:$this
    .... value[x]:valueCodeableConcept SΣC 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health

    ... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    ... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


    ... note 0..* Annotation Comments about the observation
    ... bodySite 0..1 CodeableConcept Observed body part
    Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

    ... method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.

    ... specimen 0..1 Reference(Specimen) Specimen used for this observation
    ... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    ... referenceRange C 0..* BackboneElement Provides guide for interpretation
    obs-3: Must have at least a low or a high or text
    .... 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
    .... low C 0..1 SimpleQuantity Low Range, if relevant
    .... high C 0..1 SimpleQuantity High Range, if relevant
    .... type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

    .... appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


    .... age 0..1 Range Applicable age range, if relevant
    .... text 0..1 string Text based reference range in an observation
    ... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
    ... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
    ... Slices for component SΣ 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code
    .... component:All Slices Content/Rules for all slices
    ..... 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 Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.

    ..... value[x] Σ 0..1 Actual component result
    ...... valueQuantity Quantity
    ...... valueCodeableConcept CodeableConcept
    ...... valueString string
    ...... valueBoolean boolean
    ...... valueInteger integer
    ...... valueRange Range
    ...... valueRatio Ratio
    ...... valueSampledData SampledData
    ...... valueTime time
    ...... valueDateTime dateTime
    ...... valuePeriod Period
    ..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    ..... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


    ..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
    .... component:industry SΣ 0..1 BackboneElement Occupation industry
    ..... 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 SΣ 1..1 CodeableConcept Occupation industry history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    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://loinc.org
    ....... version 0..1 string Version of the system - if relevant
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 86188-0
    ....... 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
    ..... value[x] SΣ 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health

    ..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    ..... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


    ..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Observation.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Observation.statusrequiredObservationStatus
    http://hl7.org/fhir/ValueSet/observation-status|4.0.1
    from the FHIR Standard
    Observation.categorypreferredObservationCategoryCodes
    http://hl7.org/fhir/ValueSet/observation-category
    from the FHIR Standard
    Observation.category:socialhistorypreferredPattern: social-history
    http://hl7.org/fhir/ValueSet/observation-category
    from the FHIR Standard
    Observation.codeexamplePattern: LOINC Code 11341-5
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.value[x]:valueCodeableConceptextensiblePHVS_Occupation_ONETSOC_Detail_ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901
    Observation.dataAbsentReasonextensibleDataAbsentReason
    http://hl7.org/fhir/ValueSet/data-absent-reason
    from the FHIR Standard
    Observation.interpretationextensibleObservationInterpretationCodes
    http://hl7.org/fhir/ValueSet/observation-interpretation
    from the FHIR Standard
    Observation.bodySiteexampleSNOMEDCTBodyStructures
    http://hl7.org/fhir/ValueSet/body-site
    from the FHIR Standard
    Observation.methodexampleObservationMethods
    http://hl7.org/fhir/ValueSet/observation-methods
    from the FHIR Standard
    Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
    http://hl7.org/fhir/ValueSet/referencerange-meaning
    from the FHIR Standard
    Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
    http://hl7.org/fhir/ValueSet/referencerange-appliesto
    from the FHIR Standard
    Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.component.dataAbsentReasonextensibleDataAbsentReason
    http://hl7.org/fhir/ValueSet/data-absent-reason
    from the FHIR Standard
    Observation.component.interpretationextensibleObservationInterpretationCodes
    http://hl7.org/fhir/ValueSet/observation-interpretation
    from the FHIR Standard
    Observation.component:industry.codeexamplePattern: LOINC Code 86188-0
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.component:industry.value[x]extensiblePHVS_Industry_NAICS_Detail _ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7900
    Observation.component:industry.dataAbsentReasonextensibleDataAbsentReason
    http://hl7.org/fhir/ValueSet/data-absent-reason
    from the FHIR Standard
    Observation.component:industry.interpretationextensibleObservationInterpretationCodes
    http://hl7.org/fhir/ValueSet/observation-interpretation
    from the FHIR Standard

    This structure is derived from Observation

    Summary

    Mandatory: 2 elements(1 nested mandatory element)
    Must-Support: 11 elements

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Observation.category
    • The element 1 is sliced based on the value of Observation.component

    Maturity: 3

    Differential View

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Observation 0..* Observation Past Or Present Occupation
    ... status S 1..1 code registered | preliminary | final | amended +
    ... Slices for category S 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    .... category:socialhistory S 0..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: social-history
    ... code S 1..1 CodeableConcept Occupation history
    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://loinc.org
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 11341-5
    ... subject S 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    ... effectivePeriod S 0..1 Period Clinically relevant time/time-period for observation
    ... valueCodeableConcept S 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health

    ... Slices for component S 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code
    .... component:industry S 0..1 BackboneElement Occupation industry
    ..... code S 1..1 CodeableConcept Occupation industry history
    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://loinc.org
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 86188-0
    ..... valueCodeableConcept S 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health


    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Observation.valueCodeableConceptextensiblePHVS_Occupation_ONETSOC_Detail_ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901
    Observation.component:industry.valueCodeableConceptextensiblePHVS_Industry_NAICS_Detail _ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7900

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Observation C 0..* Observation Past Or Present Occupation
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?! 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
    ... status ?!SΣ 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.


    ele-1: All FHIR elements must have a @value or children
    ... Slices for category S 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


    ele-1: All FHIR elements must have a @value or children
    .... category:socialhistory S 0..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


    ele-1: All FHIR elements must have a @value or children

    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: social-history
    ... code SΣ 1..1 CodeableConcept Occupation history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    ele-1: All FHIR elements must have a @value or children
    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://loinc.org
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 11341-5
    ... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    ele-1: All FHIR elements must have a @value or children
    ... Slices for effective[x] Σ 0..1 Clinically relevant time/time-period for observation
    Slice: Unordered, Open by type:$this
    ele-1: All FHIR elements must have a @value or children
    .... effectiveDateTime dateTime
    .... effectivePeriod Period
    .... effectiveTiming Timing
    .... effectiveInstant instant
    .... effective[x]:effectivePeriod SΣ 0..1 Period Clinically relevant time/time-period for observation
    ele-1: All FHIR elements must have a @value or children
    ... Slices for value[x] ΣC 1..1 CodeableConcept Actual result
    Slice: Unordered, Closed by type:$this
    ele-1: All FHIR elements must have a @value or children
    .... value[x]:valueCodeableConcept SΣC 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health


    ele-1: All FHIR elements must have a @value or children
    ... Slices for component SΣ 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code
    ele-1: All FHIR elements must have a @value or children
    .... component:All Slices Content/Rules for all slices
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    ele-1: All FHIR elements must have a @value or children
    .... component:industry SΣ 0..1 BackboneElement Occupation industry
    ele-1: All FHIR elements must have a @value or children
    ..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ..... code SΣ 1..1 CodeableConcept Occupation industry history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    ele-1: All FHIR elements must have a @value or children
    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://loinc.org
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 86188-0
    ..... value[x] SΣ 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health


    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Observation.statusrequiredObservationStatus
    http://hl7.org/fhir/ValueSet/observation-status|4.0.1
    from the FHIR Standard
    Observation.categorypreferredObservationCategoryCodes
    http://hl7.org/fhir/ValueSet/observation-category
    from the FHIR Standard
    Observation.category:socialhistorypreferredPattern: social-history
    http://hl7.org/fhir/ValueSet/observation-category
    from the FHIR Standard
    Observation.codeexamplePattern: LOINC Code 11341-5
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.value[x]:valueCodeableConceptextensiblePHVS_Occupation_ONETSOC_Detail_ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901
    Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.component:industry.codeexamplePattern: LOINC Code 86188-0
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.component:industry.value[x]extensiblePHVS_Industry_NAICS_Detail _ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7900

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Observation C 0..* Observation Past Or Present Occupation
    obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier Σ 0..* Identifier Business Identifier for observation
    ... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    ... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    ... status ?!SΣ 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.

    ... Slices for category S 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


    .... category:socialhistory S 0..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



    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: social-history
    ...... 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 SΣ 1..1 CodeableConcept Occupation history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    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://loinc.org
    ..... version 0..1 string Version of the system - if relevant
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 11341-5
    ..... 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 SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    ... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    ... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
    ... Slices for effective[x] Σ 0..1 Clinically relevant time/time-period for observation
    Slice: Unordered, Open by type:$this
    .... effectiveDateTime dateTime
    .... effectivePeriod Period
    .... effectiveTiming Timing
    .... effectiveInstant instant
    .... effective[x]:effectivePeriod SΣ 0..1 Period Clinically relevant time/time-period for observation
    ... issued Σ 0..1 instant Date/Time this version was made available
    ... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
    ... Slices for value[x] ΣC 1..1 CodeableConcept Actual result
    Slice: Unordered, Closed by type:$this
    .... value[x]:valueCodeableConcept SΣC 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health

    ... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    ... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


    ... note 0..* Annotation Comments about the observation
    ... bodySite 0..1 CodeableConcept Observed body part
    Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

    ... method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.

    ... specimen 0..1 Reference(Specimen) Specimen used for this observation
    ... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    ... referenceRange C 0..* BackboneElement Provides guide for interpretation
    obs-3: Must have at least a low or a high or text
    .... 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
    .... low C 0..1 SimpleQuantity Low Range, if relevant
    .... high C 0..1 SimpleQuantity High Range, if relevant
    .... type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

    .... appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


    .... age 0..1 Range Applicable age range, if relevant
    .... text 0..1 string Text based reference range in an observation
    ... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
    ... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
    ... Slices for component SΣ 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code
    .... component:All Slices Content/Rules for all slices
    ..... 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 Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.

    ..... value[x] Σ 0..1 Actual component result
    ...... valueQuantity Quantity
    ...... valueCodeableConcept CodeableConcept
    ...... valueString string
    ...... valueBoolean boolean
    ...... valueInteger integer
    ...... valueRange Range
    ...... valueRatio Ratio
    ...... valueSampledData SampledData
    ...... valueTime time
    ...... valueDateTime dateTime
    ...... valuePeriod Period
    ..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    ..... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


    ..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
    .... component:industry SΣ 0..1 BackboneElement Occupation industry
    ..... 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 SΣ 1..1 CodeableConcept Occupation industry history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.


    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://loinc.org
    ....... version 0..1 string Version of the system - if relevant
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: 86188-0
    ....... 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
    ..... value[x] SΣ 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health

    ..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

    ..... interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


    ..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Observation.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Observation.statusrequiredObservationStatus
    http://hl7.org/fhir/ValueSet/observation-status|4.0.1
    from the FHIR Standard
    Observation.categorypreferredObservationCategoryCodes
    http://hl7.org/fhir/ValueSet/observation-category
    from the FHIR Standard
    Observation.category:socialhistorypreferredPattern: social-history
    http://hl7.org/fhir/ValueSet/observation-category
    from the FHIR Standard
    Observation.codeexamplePattern: LOINC Code 11341-5
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.value[x]:valueCodeableConceptextensiblePHVS_Occupation_ONETSOC_Detail_ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7901
    Observation.dataAbsentReasonextensibleDataAbsentReason
    http://hl7.org/fhir/ValueSet/data-absent-reason
    from the FHIR Standard
    Observation.interpretationextensibleObservationInterpretationCodes
    http://hl7.org/fhir/ValueSet/observation-interpretation
    from the FHIR Standard
    Observation.bodySiteexampleSNOMEDCTBodyStructures
    http://hl7.org/fhir/ValueSet/body-site
    from the FHIR Standard
    Observation.methodexampleObservationMethods
    http://hl7.org/fhir/ValueSet/observation-methods
    from the FHIR Standard
    Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
    http://hl7.org/fhir/ValueSet/referencerange-meaning
    from the FHIR Standard
    Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
    http://hl7.org/fhir/ValueSet/referencerange-appliesto
    from the FHIR Standard
    Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.component.dataAbsentReasonextensibleDataAbsentReason
    http://hl7.org/fhir/ValueSet/data-absent-reason
    from the FHIR Standard
    Observation.component.interpretationextensibleObservationInterpretationCodes
    http://hl7.org/fhir/ValueSet/observation-interpretation
    from the FHIR Standard
    Observation.component:industry.codeexamplePattern: LOINC Code 86188-0
    http://hl7.org/fhir/ValueSet/observation-codes
    from the FHIR Standard
    Observation.component:industry.value[x]extensiblePHVS_Industry_NAICS_Detail _ODH
    http://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7900
    Observation.component:industry.dataAbsentReasonextensibleDataAbsentReason
    http://hl7.org/fhir/ValueSet/data-absent-reason
    from the FHIR Standard
    Observation.component:industry.interpretationextensibleObservationInterpretationCodes
    http://hl7.org/fhir/ValueSet/observation-interpretation
    from the FHIR Standard

    This structure is derived from Observation

    Summary

    Mandatory: 2 elements(1 nested mandatory element)
    Must-Support: 11 elements

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Observation.category
    • The element 1 is sliced based on the value of Observation.component

    Maturity: 3

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Quick Start

    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements section for additional rules and expectations when a Server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple patients.

    US Core Scopes

    Servers providing access to social history data SHALL support these US Core SMART Scopes:

    • resource level scopes: <patient|user|system>/Observation.rs

    • granular scopes: <patient|user|system>/Observation.rs?category=http://terminology.hl7.org//CodeSystem-observation-category|social-history

    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support searching using the combination of the patient and category search parameters:

      GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory

      Example:

      1. GET [base]/Observation?patient=1134281&amp;category=social-history

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and a category code = laboratory (how to search by reference and how to search by token)

    2. SHALL support searching using the combination of the patient and code search parameters:
      • including optional support for OR search on code (e.g.code={system|}[code],{system|}[code],...)

      GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

      Example:

      1. GET [base]/Observation?patient=1134281&amp;code=http://loinc.org|11341-5

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and observation code(s). SHOULD support search by multiple report codes. The Observation code parameter searches `Observation.code only. (how to search by reference and how to search by token)

    3. SHALL support searching using the combination of the patient and category and date search parameters:
      • including support for these date comparators: gt,lt,ge,le
      • including optional support for AND search on date (e.g.date=[date]&date=[date]]&...)

      GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

      Example:

      1. GET [base]Observation?patient=555580&category=social-history&date=ge2018-03-14T00:00:00Z

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and a category code = laboratory (how to search by reference and how to search by token and how to search by date)

    Optional Search Parameters:

    The following search parameter combinations SHOULD be supported:

    1. SHOULD support searching using the combination of the patient and category and status search parameters:
      • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

      GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&status={system|}[code]{,{system|}[code],...}

      Example:

      1. GET [base]/Observation?patient=1134281&category=social-history&status=final

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category = laboratory and status (how to search by reference and how to search by token)

    2. SHOULD support searching using the combination of the patient and category and _lastUpdated search parameters:
      • including support for these _lastUpdated comparators: gt,lt,ge,le
      • including optional support for AND search on _lastUpdated (e.g._lastUpdated=[date]&_lastUpdated=[date]]&...)

      GET [base]/Observation?patient={Type/}[id]&category={system|}[code]&_lastUpdated={gt|lt|ge|le}[date]{&_lastUpdated={gt|lt|ge|le}[date]&...}

      Example:

      1. GET [base]Observation?patient=555580&social-history&_lastUpdated=ge2024-01-01T00:00:00Z

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category and _lastUpdated. See the US Core General Guidance page for Searching Using lastUpdated. (how to search by reference and how to search by token and how to search by date)

    3. SHOULD support searching using the combination of the patient and code and date search parameters:
      • including optional support for OR search on code (e.g.code={system|}[code],{system|}[code],...)
      • including support for these date comparators: gt,lt,ge,le
      • including optional support for AND search on date (e.g.date=[date]&date=[date]]&...)

      GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

      Example:

      1. GET [base]Observation?patient=555580&code=http://loinc.org|11341-5&date=ge2019-01-01T00:00:00Z

      Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and report code(s). SHOULD support search by multiple report codes. (how to search by reference and how to search by token and how to search by date)