STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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 Race
  • ethnicity - (0..1) A CodeableConcept bound to the v3 valueset for Ethnicity

Extensions to Address

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

Extensions to ContactPoint

  • 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-raceA category of humans sharing history, origin or nationality :

A code classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.

us-core-ethnicityA category of human sharing heritage :

A code classifying the person into a named category of humans sharing a common real or presumed heritage.

us-core-religionPatient's professed religious affiliation :

A code classifying a person's professed religion.

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-concernStatusThe status of a Concern associated with a condition :

This communicates the status of the Concern associated with a condition. Values can be Active/Inactive/Resolved.

us-core-birthsexSex of patient assigned at birth :

A code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC).

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