Kids First Implementation Guide
0.1.0 - CI Build
Kids First Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
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:
The official URL for this extension is:
http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Status: active
Extension maintained by: Kids First DRC
Context of Use
This extension may be used on the following element(s):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..1 | Extension | US Core Race Extension | |
extension:ombCategory | S | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White |
url | 1..1 | uri | "ombCategory" | |
valueCoding | 1..1 | Coding | Value of extension Binding: OMB Race Categories (required) | |
extension:detailed | 0..* | Extension | Extended race codes | |
url | 1..1 | uri | "detailed" | |
valueCoding | 1..1 | Coding | Value of extension Binding: Detailed Race (required) | |
extension:text | S | 1..1 | Extension | Race Text |
url | 1..1 | uri | "text" | |
valueString | 1..1 | string | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" | |
value[x] | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | I | 0..1 | Extension | US Core Race Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
extension:ombCategory | SI | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | I | 0..1 | Value of extension | |
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "ombCategory" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCoding | I | 1..1 | Coding | Value of extension Binding: OMB Race Categories (required) |
extension:detailed | I | 0..* | Extension | Extended race codes |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | I | 0..1 | Value of extension | |
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "detailed" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCoding | I | 1..1 | Coding | Value of extension Binding: Detailed Race (required) |
extension:text | SI | 1..1 | Extension | Race Text |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | I | 0..1 | Value of extension | |
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "text" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueString | I | 1..1 | string | Value of extension |
url | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" | |
Documentation for this format |
This structure is derived from Extension
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..1 | Extension | US Core Race Extension | |
extension:ombCategory | S | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White |
url | 1..1 | uri | "ombCategory" | |
valueCoding | 1..1 | Coding | Value of extension Binding: OMB Race Categories (required) | |
extension:detailed | 0..* | Extension | Extended race codes | |
url | 1..1 | uri | "detailed" | |
valueCoding | 1..1 | Coding | Value of extension Binding: Detailed Race (required) | |
extension:text | S | 1..1 | Extension | Race Text |
url | 1..1 | uri | "text" | |
valueString | 1..1 | string | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" | |
value[x] | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | I | 0..1 | Extension | US Core Race Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
extension:ombCategory | SI | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | I | 0..1 | Value of extension | |
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "ombCategory" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCoding | I | 1..1 | Coding | Value of extension Binding: OMB Race Categories (required) |
extension:detailed | I | 0..* | Extension | Extended race codes |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | I | 0..1 | Value of extension | |
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "detailed" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCoding | I | 1..1 | Coding | Value of extension Binding: Detailed Race (required) |
extension:text | SI | 1..1 | Extension | Race Text |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | I | 0..1 | Value of extension | |
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
url | 1..1 | uri | "text" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueString | I | 1..1 | string | Value of extension |
url | 1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" | |
Documentation for this format |
Other representations of extension: Schematron
Path | Conformance | ValueSet |
Extension.extension:ombCategory.value[x]:valueCoding | required | OmbRaceCategories |
Extension.extension:detailed.value[x]:valueCoding | required | DetailedRace |
Id | Path | Details | Requirements |
ele-1 | Extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:ombCategory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension:ombCategory | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:ombCategory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension:ombCategory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:ombCategory.extension.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension:ombCategory.extension.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:ombCategory.extension.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Extension.extension:ombCategory.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Extension.extension:ombCategory.value[x]:valueCoding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Extension.extension:detailed | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension:detailed | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:detailed.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension:detailed.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:detailed.extension.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension:detailed.extension.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:detailed.extension.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Extension.extension:detailed.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Extension.extension:detailed.value[x]:valueCoding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Extension.extension:text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension:text | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:text.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension:text.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:text.extension.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Extension.extension:text.extension.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Extension.extension:text.extension.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Extension.extension:text.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Extension.extension:text.value[x]:valueString | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |