Argonaut Data Query Implementation Guide Version 1.0.0

This page is part of the Argonaut Data Query Implementation Guide (v1.0.0: Release) based on FHIR R2. This is the current published version. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-argo-race

Argonaut Race Extension

Scope and Usage

This Complex Extension for race allows one or more race codes of which:

  • Must Support at least one code from OMB Race Categories
  • May include additional race codes from CDC Race Codes
  • Must include text description of race

Context of Use: Argonaut Patient Profile

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://fhir.org/guides/argonaut/StructureDefinition/argo-race

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.

This profile builds on Extension.

This profile was published on Tue Oct 18 00:00:00 AEDT 2016 as a draft by Argonaut Project.

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

Summary of the Mandatory Requirements

  1. Must Support at least one code from OMB Race Categories
  2. May include additional race codes from CDC Race Codes
  3. Must include text
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Argonaut Race Extension
... url 1..1"http://fhir.org/guides/argonaut/StructureDefinition/argo-race"
... extension S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingBinding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingBinding: US-Core Detailed Race (required)
... extension S1..1ExtensionRace Text
.... url 1..1uri"text"
.... valueString 1..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Argonaut Race Extension
... id 0..1idxml:id (or equivalent in JSON)
... extension S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Race Categories (extensible)
... extension 0..*ExtensionExtended race codes
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: US-Core Detailed Race (required)
... extension S1..1ExtensionRace Text
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"text"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://fhir.org/guides/argonaut/StructureDefinition/argo-race"

doco Documentation for this format

Summary of the Mandatory Requirements

  1. Must Support at least one code from OMB Race Categories
  2. May include additional race codes from CDC Race Codes
  3. Must include text

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Argonaut Race Extension
... url 1..1"http://fhir.org/guides/argonaut/StructureDefinition/argo-race"
... extension S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingBinding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingBinding: US-Core Detailed Race (required)
... extension S1..1ExtensionRace Text
.... url 1..1uri"text"
.... valueString 1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Argonaut Race Extension
... id 0..1idxml:id (or equivalent in JSON)
... extension S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Race Categories (extensible)
... extension 0..*ExtensionExtended race codes
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: US-Core Detailed Race (required)
... extension S1..1ExtensionRace Text
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"text"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://fhir.org/guides/argonaut/StructureDefinition/argo-race"

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the Argonaut Data Query implementation guide server for a complete list of supported RESTful operations and search parameters for this IG.

No Search criteria for argo-race extension.