STU3 Candidate

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

United States Realm FHIR Profile

Scope and Usage

This profile defines several extensions relevant to the US realm

Extensions to Patient

  • race - (0..1) A CodeableConcept bound to the v3 valueset for the 5 OMB Race categories and 900+ detailed race codes
  • ethnicity - (0..1) A CodeableConcept bound to the v3 valueset for the 2 ONB Ethnicity categories and 40+ detalied ethnicity codes
  • birthsex - (0..1) A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC).

Extensions to Address

  • county - (0..1) A string containing the name of the county

Extensions to ContactPoint Datatype

  • direct - (0..1) A boolean flag indicating that a particular email address can be used with the Direct Protocol

An example Patient showing these extensions can be found here.

Content

Extensions:
us-core-directEmail is a "direct" email :

This email address is associated with a "direct" service - e.g. http://wiki.directproject.org/Addressing+Specification.

us-core-raceUS Core Race Extension :

Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories: - American Indian or Alaska Native - Asian - Black or African American - Native Hawaiian or Other Pacific Islander - White.

us-core-ethnicityUS Core ethnicity Extension :

Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.

Search Parameters

Search parameters defined by this package. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPathsSource
ethnicitytokenReturns patients with an ethnicity extension matching the specified code.f:Patient/f:extension[@url='http://hl7.org/fhir/StructureDefinition/us-core-ethnicity'] | f:Patient/f:extension[@url='http://hl7.org/fhir/StructureDefinition/us-core-ethnicity']XML / JSON
racetokenReturns patients with a race extension matching the specified code.f:Patient/f:extension[@url='http://hl7.org/fhir/StructureDefinition/us-core-race'] | f:Patient/f:extension[@url='http://hl7.org/fhir/StructureDefinition/us-core-race']XML / JSON