US Core

In this tutorial we will guide you how to setup US Core FHIR Implementation Guide.

Setup Aidbox with US Core IG version 6.1.0

Follow getting started guide. Add the dependency:

AIDBOX_FHIR_PACKAGES=hl7.fhir.r4.core#4.0.1:hl7.fhir.us.core#6.1.0

Validate example resources against US Core profiles

Valid Patient resource
POST /fhir/Patient
 
resourceType: Patient
meta:
  profile:
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
extension:
- extension:
  - url: ombCategory
    valueCoding:
      system: urn:oid:2.16.840.1.113883.6.238
      code: 2028-9
      display: Asian
  - url: text
    valueString: Asian
  url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
- extension:
  - url: ombCategory
    valueCoding:
      system: urn:oid:2.16.840.1.113883.6.238
      code: 2186-5
      display: Not Hispanic or Latino
  - url: text
    valueString: Not Hispanic or Latino
  url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
- url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
  valueCode: M
- url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
  valueCode: '248153007'
identifier:
- use: usual
  type:
    coding:
    - system: http://terminology.hl7.org/CodeSystem/v2-0203
      code: MR
      display: Medical Record Number
    text: Medical Record Number
  system: http://hospital.smarthealthit.org
  value: '1032704'
active: true
name:
- family: Example
  given:
  - Child
telecom:
- system: phone
  value: 555-555-5555
  use: home
gender: male
birthDate: '2016-01-15'
address:
- line:
  - 49 Meadow St
  city: Mounds
  state: OK
  postalCode: '74047'
  country: US

The sample of the Patient resource is invalid because it does not comply with the required keys, identifier and gender. It violates the us-core-6 FHIRPath constraint due to the absence of the family and given properties and the data-absent-reason extension in the name property. Additionally, it violates the terminology binding on the ombCategory extension.

Invalid Patient resource
POST /fhir/Patient
 
resourceType: Patient
meta:
  profile:
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
extension:
- extension:
  - url: ombCategory
    valueCoding:
      system: urn:oid:2.16.840.1.113883.6.238
      code: some-nonsense
      display: Asian
  - url: text
    valueString: Asian
  url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
- extension:
  - url: ombCategory
    valueCoding:
      system: urn:oid:2.16.840.1.113883.6.238
      code: 2186-5
      display: Not Hispanic or Latino
  - url: text
    valueString: Not Hispanic or Latino
  url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
- url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
  valueCode: M
- url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
  valueCode: '248153007'
active: true
name:
- use: official
telecom:
- system: phone
  value: 555-555-5555
  use: home
birthDate: '2016-01-15'
address:
- line:
  - 49 Meadow St
  city: Mounds
  state: OK
  postalCode: '74047'
  country: US
PreviousCarin BB
NextDavinci Pdex

Last updated 2025-05-13T12:31:10Z