US Core Implementation Guide
10.0.0-ballot - STU 10 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 10.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: 10.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.44

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

Additional USCDI Requirements:

These Additional USCDI Requirements elements are not Mandatory or Must Support but are required for ONC Health IT certification testing and are included in the formal definition of the profile and the Observation examples.

  1. a performer1

1 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

  • The observations MAY have additional codes that translate or map to the Observation code or category codes.§ For example:
    • providing a local system-specific code
    • providing more specific codes

    A code system value SHOULD be supplied for each additional code.§

  • For the current job, systems SHALL omit observation.effectivePeriod.end to indicate it is ongoing.§
  • When the industry is known, but the occupation is not, systems SHALL use the value "unknown" from the DataAbsentReason Code System.§ However, when the occupation is known but the industry is not, systems SHALL 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.
  • 1The profile elements Observation.performer and Observation.device communicate the individual level provenance author data corresponding to the U.S. Core Data for Interoperability (USCDI) Provenance Author Data Elements.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 9.0.0:

  • No changes
  • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Past Or Present Occupation
    Constraints: obs-6, obs-7
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    Observation.Slices for category This element must be supported. 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialhistory This element must be supported. 0..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
          "code" : "social-history"
        }
      ]
    }
    Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "11341-5"
        }
      ]
    }
    Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.Slices for effective[x] This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
    Slice: Unordered, Closed by type:$this
    Slicing Note: Other type slices that contain no new information are not shown in this view
    Observation.Slices for effective[x].effectiveDateTime dateTime
    Observation.Slices for effective[x].effectivePeriod Period
    Observation.Slices for effective[x].effectiveTiming Timing
    Observation.Slices for effective[x].effectiveInstant instant
    Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period Clinically relevant time/time-period for observation
    Observation.performer This element is included in summaries. 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
    Observation.Slices for value[x] This element is included in summaries. C 1..1 CodeableConcept Actual result
    Slice: Unordered, Closed by type:$this
    Observation.Slices for value[x].value[x]:valueCodeableConcept This element must be supported. This element is included in summaries. C 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health
    Observation.Slices for component This element must be supported. This element is included in summaries. 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for component.component:All Slices Content/Rules for all slices
    Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.Slices for component.component:All Slices.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Observation.Slices for component.component:industry This element must be supported. This element is included in summaries. 0..1 BackboneElement Occupation industry
    Observation.Slices for component.component:industry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.Slices for component.component:industry.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation industry history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "86188-0"
        }
      ]
    }
    Observation.Slices for component.component:industry.Slices for value[x] This element is included in summaries. 1..1 CodeableConcept Actual component result
    Slice: Unordered, Closed by type:$this
    Observation.Slices for component.component:industry.Slices for value[x] Content/Rules for all slices
    Observation.Slices for component.component:industry.Slices for value[x].value[x]:valueCodeableConcept This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:socialhistory Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.value[x]:valueCodeableConcept Base extensible Occupation ONETSOC Detail (ODH) 📦1 us.cdc.phinvads v0.12
    Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.component:industry.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.component:industry.​value[x]:valueCodeableConcept Base extensible Industry NAICS Detail (ODH) 📦1 us.cdc.phinvads v0.12

    Constraints

    Id Grade Path(s) Description Expression

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation 0..* Observation Past Or Present Occupation
    Observation.status This element must be supported. 1..1 code registered | preliminary | final | amended +
    Observation.Slices for category This element must be supported. 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialhistory This element must be supported. 0..1 CodeableConcept Classification of type of observation
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
          "code" : "social-history"
        }
      ]
    }
    Observation.code This element must be supported. 1..1 CodeableConcept Occupation history
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "11341-5"
        }
      ]
    }
    Observation.subject This element must be supported. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.effectivePeriod This element must be supported. 0..1 Period Clinically relevant time/time-period for observation
    Observation.performer 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
    Observation.valueCodeableConcept This element must be supported. 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health
    Observation.Slices for component This element must be supported. 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for component.component:industry This element must be supported. 0..1 BackboneElement Occupation industry
    Observation.Slices for component.component:industry.code This element must be supported. 1..1 CodeableConcept Occupation industry history
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "86188-0"
        }
      ]
    }
    Observation.Slices for component.component:industry.valueCodeableConcept This element must be supported. 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)

    Path Status Usage ValueSet Version Source
    Observation.valueCodeableConcept Base extensible Occupation ONETSOC Detail (ODH) 📦1 us.cdc.phinvads v0.12
    Observation.component:industry.​valueCodeableConcept Base extensible Industry NAICS Detail (ODH) 📦1 us.cdc.phinvads v0.12
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Past Or Present Occupation
    Constraints: obs-6, obs-7
    Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
    Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Observation.contained 0..* Resource Contained, inline Resources
    Observation.extension 0..* Extension Additional content defined by implementations
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
    Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    Observation.Slices for category This element must be supported. 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialhistory This element must be supported. 0..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
          "code" : "social-history"
        }
      ]
    }
    Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "11341-5"
        }
      ]
    }
    Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
    Observation.Slices for effective[x] This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
    Slice: Unordered, Closed by type:$this
    Slicing Note: Other type slices that contain no new information are not shown in this view
    Observation.Slices for effective[x].effectiveDateTime dateTime
    Observation.Slices for effective[x].effectivePeriod Period
    Observation.Slices for effective[x].effectiveTiming Timing
    Observation.Slices for effective[x].effectiveInstant instant
    Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period Clinically relevant time/time-period for observation
    Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
    Observation.performer This element is included in summaries. 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
    Observation.Slices for value[x] This element is included in summaries. C 1..1 CodeableConcept Actual result
    Slice: Unordered, Closed by type:$this
    Observation.Slices for value[x].value[x]:valueCodeableConcept This element must be supported. This element is included in summaries. C 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health
    Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.note 0..* Annotation Comments about the observation
    Observation.bodySite 0..1 CodeableConcept Observed body part
    Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
    Observation.method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.
    Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
    Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
    Constraints: obs-3
    Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
    Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
    Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
    Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
    Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
    Observation.referenceRange.text 0..1 string Text based reference range in an observation
    Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
    Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
    Observation.Slices for component This element must be supported. This element is included in summaries. 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for component.component:All Slices Content/Rules for all slices
    Observation.Slices for component.component:All Slices.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for component.component:All Slices.extension 0..* Extension Additional content defined by implementations
    Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.Slices for component.component:All Slices.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Observation.Slices for component.component:All Slices.value[x] This element is included in summaries. 0..1 Actual component result
    Observation.Slices for component.component:All Slices.value[x].valueQuantity Quantity
    Observation.Slices for component.component:All Slices.value[x].valueCodeableConcept CodeableConcept
    Observation.Slices for component.component:All Slices.value[x].valueString string
    Observation.Slices for component.component:All Slices.value[x].valueBoolean boolean
    Observation.Slices for component.component:All Slices.value[x].valueInteger integer
    Observation.Slices for component.component:All Slices.value[x].valueRange Range
    Observation.Slices for component.component:All Slices.value[x].valueRatio Ratio
    Observation.Slices for component.component:All Slices.value[x].valueSampledData SampledData
    Observation.Slices for component.component:All Slices.value[x].valueTime time
    Observation.Slices for component.component:All Slices.value[x].valueDateTime dateTime
    Observation.Slices for component.component:All Slices.value[x].valuePeriod Period
    Observation.Slices for component.component:All Slices.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.Slices for component.component:All Slices.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.Slices for component.component:All Slices.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
    Observation.Slices for component.component:industry This element must be supported. This element is included in summaries. 0..1 BackboneElement Occupation industry
    Observation.Slices for component.component:industry.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for component.component:industry.extension 0..* Extension Additional content defined by implementations
    Observation.Slices for component.component:industry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.Slices for component.component:industry.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation industry history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "86188-0"
        }
      ]
    }
    Observation.Slices for component.component:industry.Slices for value[x] This element is included in summaries. 1..1 CodeableConcept Actual component result
    Slice: Unordered, Closed by type:$this
    Observation.Slices for component.component:industry.Slices for value[x] Content/Rules for all slices
    Observation.Slices for component.component:industry.Slices for value[x].value[x]:valueCodeableConcept This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health
    Observation.Slices for component.component:industry.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.Slices for component.component:industry.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.Slices for component.component:industry.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:socialhistory Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.value[x]:valueCodeableConcept Base extensible Occupation ONETSOC Detail (ODH) 📦1 us.cdc.phinvads v0.12
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
    Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
    Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
    Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
    Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
    Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
    Observation.component:industry.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.component:industry.​value[x]:valueCodeableConcept Base extensible Industry NAICS Detail (ODH) 📦1 us.cdc.phinvads v0.12
    Observation.component:industry.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component:industry.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    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

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Past Or Present Occupation
    Constraints: obs-6, obs-7
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    Observation.Slices for category This element must be supported. 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialhistory This element must be supported. 0..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
          "code" : "social-history"
        }
      ]
    }
    Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "11341-5"
        }
      ]
    }
    Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.Slices for effective[x] This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
    Slice: Unordered, Closed by type:$this
    Slicing Note: Other type slices that contain no new information are not shown in this view
    Observation.Slices for effective[x].effectiveDateTime dateTime
    Observation.Slices for effective[x].effectivePeriod Period
    Observation.Slices for effective[x].effectiveTiming Timing
    Observation.Slices for effective[x].effectiveInstant instant
    Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period Clinically relevant time/time-period for observation
    Observation.performer This element is included in summaries. 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
    Observation.Slices for value[x] This element is included in summaries. C 1..1 CodeableConcept Actual result
    Slice: Unordered, Closed by type:$this
    Observation.Slices for value[x].value[x]:valueCodeableConcept This element must be supported. This element is included in summaries. C 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health
    Observation.Slices for component This element must be supported. This element is included in summaries. 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for component.component:All Slices Content/Rules for all slices
    Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.Slices for component.component:All Slices.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Observation.Slices for component.component:industry This element must be supported. This element is included in summaries. 0..1 BackboneElement Occupation industry
    Observation.Slices for component.component:industry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.Slices for component.component:industry.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation industry history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "86188-0"
        }
      ]
    }
    Observation.Slices for component.component:industry.Slices for value[x] This element is included in summaries. 1..1 CodeableConcept Actual component result
    Slice: Unordered, Closed by type:$this
    Observation.Slices for component.component:industry.Slices for value[x] Content/Rules for all slices
    Observation.Slices for component.component:industry.Slices for value[x].value[x]:valueCodeableConcept This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:socialhistory Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.value[x]:valueCodeableConcept Base extensible Occupation ONETSOC Detail (ODH) 📦1 us.cdc.phinvads v0.12
    Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.component:industry.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.component:industry.​value[x]:valueCodeableConcept Base extensible Industry NAICS Detail (ODH) 📦1 us.cdc.phinvads v0.12

    Constraints

    Id Grade Path(s) Description Expression

    Differential View

    This structure is derived from Observation

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation 0..* Observation Past Or Present Occupation
    Observation.status This element must be supported. 1..1 code registered | preliminary | final | amended +
    Observation.Slices for category This element must be supported. 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialhistory This element must be supported. 0..1 CodeableConcept Classification of type of observation
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
          "code" : "social-history"
        }
      ]
    }
    Observation.code This element must be supported. 1..1 CodeableConcept Occupation history
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "11341-5"
        }
      ]
    }
    Observation.subject This element must be supported. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.effectivePeriod This element must be supported. 0..1 Period Clinically relevant time/time-period for observation
    Observation.performer 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
    Observation.valueCodeableConcept This element must be supported. 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health
    Observation.Slices for component This element must be supported. 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for component.component:industry This element must be supported. 0..1 BackboneElement Occupation industry
    Observation.Slices for component.component:industry.code This element must be supported. 1..1 CodeableConcept Occupation industry history
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "86188-0"
        }
      ]
    }
    Observation.Slices for component.component:industry.valueCodeableConcept This element must be supported. 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)

    Path Status Usage ValueSet Version Source
    Observation.valueCodeableConcept Base extensible Occupation ONETSOC Detail (ODH) 📦1 us.cdc.phinvads v0.12
    Observation.component:industry.​valueCodeableConcept Base extensible Industry NAICS Detail (ODH) 📦1 us.cdc.phinvads v0.12

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Observation C 0..* Observation Past Or Present Occupation
    Constraints: obs-6, obs-7
    Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
    Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Observation.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Observation.contained 0..* Resource Contained, inline Resources
    Observation.extension 0..* Extension Additional content defined by implementations
    Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
    Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
    Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
    Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
    Binding: ObservationStatus (required): Codes providing the status of an observation.
    Observation.Slices for category This element must be supported. 0..* CodeableConcept Classification of type of observation
    Slice: Unordered, Open by value:$this
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for category.category:socialhistory This element must be supported. 0..1 CodeableConcept Classification of type of observation
    Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
          "code" : "social-history"
        }
      ]
    }
    Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "11341-5"
        }
      ]
    }
    Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
    Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
    Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
    Observation.Slices for effective[x] This element is included in summaries. 0..1 Clinically relevant time/time-period for observation
    Slice: Unordered, Closed by type:$this
    Slicing Note: Other type slices that contain no new information are not shown in this view
    Observation.Slices for effective[x].effectiveDateTime dateTime
    Observation.Slices for effective[x].effectivePeriod Period
    Observation.Slices for effective[x].effectiveTiming Timing
    Observation.Slices for effective[x].effectiveInstant instant
    Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period Clinically relevant time/time-period for observation
    Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
    Observation.performer This element is included in summaries. 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
    Observation.Slices for value[x] This element is included in summaries. C 1..1 CodeableConcept Actual result
    Slice: Unordered, Closed by type:$this
    Observation.Slices for value[x].value[x]:valueCodeableConcept This element must be supported. This element is included in summaries. C 1..1 CodeableConcept Coded occupation or text
    Binding: Occupation ONETSOC Detail (ODH) (extensible): Occupational Data for Health
    Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.note 0..* Annotation Comments about the observation
    Observation.bodySite 0..1 CodeableConcept Observed body part
    Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
    Observation.method 0..1 CodeableConcept How it was done
    Binding: ObservationMethods (example): Methods for simple observations.
    Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
    Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
    Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
    Constraints: obs-3
    Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
    Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
    Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
    Constraints: sqty-1
    Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
    Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
    Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
    Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
    Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
    Observation.referenceRange.text 0..1 string Text based reference range in an observation
    Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
    Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
    Observation.Slices for component This element must be supported. This element is included in summaries. 0..* BackboneElement Component results
    Slice: Unordered, Open by value:code

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Observation.Slices for component.component:All Slices Content/Rules for all slices
    Observation.Slices for component.component:All Slices.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for component.component:All Slices.extension 0..* Extension Additional content defined by implementations
    Observation.Slices for component.component:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.Slices for component.component:All Slices.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Observation.Slices for component.component:All Slices.value[x] This element is included in summaries. 0..1 Actual component result
    Observation.Slices for component.component:All Slices.value[x].valueQuantity Quantity
    Observation.Slices for component.component:All Slices.value[x].valueCodeableConcept CodeableConcept
    Observation.Slices for component.component:All Slices.value[x].valueString string
    Observation.Slices for component.component:All Slices.value[x].valueBoolean boolean
    Observation.Slices for component.component:All Slices.value[x].valueInteger integer
    Observation.Slices for component.component:All Slices.value[x].valueRange Range
    Observation.Slices for component.component:All Slices.value[x].valueRatio Ratio
    Observation.Slices for component.component:All Slices.value[x].valueSampledData SampledData
    Observation.Slices for component.component:All Slices.value[x].valueTime time
    Observation.Slices for component.component:All Slices.value[x].valueDateTime dateTime
    Observation.Slices for component.component:All Slices.value[x].valuePeriod Period
    Observation.Slices for component.component:All Slices.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.Slices for component.component:All Slices.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.Slices for component.component:All Slices.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
    Observation.Slices for component.component:industry This element must be supported. This element is included in summaries. 0..1 BackboneElement Occupation industry
    Observation.Slices for component.component:industry.id 0..1 string Unique id for inter-element referencing
    Observation.Slices for component.component:industry.extension 0..* Extension Additional content defined by implementations
    Observation.Slices for component.component:industry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Observation.Slices for component.component:industry.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation industry history
    Binding: LOINCCodes (example): Codes identifying names of simple observations.
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://loinc.org",
          "code" : "86188-0"
        }
      ]
    }
    Observation.Slices for component.component:industry.Slices for value[x] This element is included in summaries. 1..1 CodeableConcept Actual component result
    Slice: Unordered, Closed by type:$this
    Observation.Slices for component.component:industry.Slices for value[x] Content/Rules for all slices
    Observation.Slices for component.component:industry.Slices for value[x].value[x]:valueCodeableConcept This element must be supported. This element is included in summaries. 1..1 CodeableConcept Occupation industry or text
    Binding: Industry NAICS Detail (ODH) (extensible): Occupational Data for Health
    Observation.Slices for component.component:industry.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
    Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
    Observation.Slices for component.component:industry.interpretation 0..* CodeableConcept High, low, normal, etc.
    Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
    Observation.Slices for component.component:industry.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
    Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.category:socialhistory Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
    Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.value[x]:valueCodeableConcept Base extensible Occupation ONETSOC Detail (ODH) 📦1 us.cdc.phinvads v0.12
    Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
    Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
    Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
    Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
    Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
    Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
    Observation.component:industry.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
    Observation.component:industry.​value[x]:valueCodeableConcept Base extensible Industry NAICS Detail (ODH) 📦1 us.cdc.phinvads v0.12
    Observation.component:industry.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
    Observation.component:industry.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    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 for all Observations using the combination of the patient and category search parameters

      GET [base]/Observation?patient={Patient/}[id]&category={system|}[search_code]

      Example:

      1. GET [base]/Observation?patient=Patient/1137192&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history

      Implementation Notes: Fetches a bundle of all US Core Observation Occupation Profile resources for the specified patient and a category code = "social-history" ( see how to search by reference and how to search by token).

    2. SHALL support searching for all Observations by code using the combination of the patient and code search parameters

      • Including optional support OR search on code (e.g.code={system|}[code],{system|}[code],...)

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

      Example:

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

      Implementation Notes: Fetches a bundle of all US Core Observation Occupation Profile resources for the specified patient and observation code(s). SHOULD support search by multiple codes. The US Core Observation Occupation Profile "code" parameter searches only .code and not component.code. ( see how to search by reference and how to search by token).

    3. SHALL support searching for all Observations by date (for example, results after 2018) using the combination of the patient and category and date search parameters

      • Including optional support for AND search on date (e.g.date=[date]&date=[date]&...)

      • Including support for these date comparators: "gt", "lt", "ge", "le"

      GET [base]/Observation?patient={Patient/}[id]&category={system|}[search_code]&date={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}

      Example:

      1. GET [base]/Observation?patient=Patient/1137192&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history&date=ge2018-03-14T00:00:00Z

      Implementation Notes: Fetches a bundle of all US Core Observation Occupation Profile resources for the specified patient and date and a category code = "social-history" ( see how to search by reference and how to search by token and how to search by date).

    Optional Search Parameters:

    The following search parameters and search parameter combinations SHOULD be supported

    1. SHOULD support searching for all Observations for a patient for a given status (for example all observations marked as final) using the combination of the patient and category and status search parameters

      • Including support OR search on status (e.g.status={system|}[code],{system|}[code],...)

      GET [base]/Observation?patient={Patient/}[id]&category={system|}[search_code]&status={system|}[search_code]{,{system|}[code],...}

      Example:

      1. GET [base]/Observation?patient=Patient/1137192&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history&status=final

      Implementation Notes: Fetches a bundle of all US Core Observation Occupation Profile resources for the specified patient and category = "social-history" and status ( see 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 optional support for AND search on _lastUpdated (e.g._lastUpdated=[date]&_lastUpdated=[date]&...)

      • Including support for these _lastUpdated comparators: "gt", "lt", "ge", "le"

      GET [base]/Observation?patient={Patient/}[id]&category={system|}[search_code]&_lastUpdated=[dateTime]

      Example:

      1. GET [base]/Observation?patient=Patient/1137192&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history&_lastUpdated=ge2024-01-01T00:00:00Z

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

    3. SHOULD support searching Observations by code and date using the combination of the patient and code and date search parameters

      • Including optional support OR search on code (e.g.code={system|}[code],{system|}[code],...)

      • Including optional support for AND search on date (e.g.date=[date]&date=[date]&...)

      • Including support for these date comparators: "gt", "lt", "ge", "le"

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

      Example:

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

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