US Core Implementation Guide
8.0.0-ballot - Ballot
US Core Implementation Guide
8.0.0-ballot - Ballot
US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions
| Page standards status: Informative |
{
"resourceType" : "Patient",
"id" : "example",
"meta" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/instance-name",
"valueString" : "Patient Example"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/instance-description",
"valueMarkdown" : "This is a patient example for the *US Core Patient Profile*."
}
],
"profile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Patient example</b></p><a name=\"example\"> </a><a name=\"hcexample\"> </a><a name=\"example-en-US\"> </a><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">Amy V. Baxter Female, DoB: 1987-02-20 ( Medical Record Number:\u00a01032702\u00a0(use:\u00a0usual,\u00a0))</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"Record is active\">Active:</td><td colspan=\"3\">true</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Alternate names (see the one above)\">Alt. Name:</td><td colspan=\"3\">Amy V. Shaw (Old)</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Ways to contact the Patient\">Contact Detail</td><td colspan=\"3\"><ul><li>ph: 555-555-5555(Home)</li><li><a href=\"mailto:amy.shaw@example.com\">amy.shaw@example.com</a></li><li>49 MEADOW ST MOUNDS OK 74047 US (old)</li><li>183 MOUNTAIN VIEW ST MOUNDS OK 74048 US </li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Language spoken\">Language:</td><td colspan=\"3\"><span title=\"Codes:{urn:ietf:bcp:47 es}\">Spanish</span> (preferred)</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This extension indicates the individual's need for an interpreter to communicate healthcare information in a language other than the default language of the organization.\"><a href=\"StructureDefinition-us-core-interpreter-required.html\">US Core Interpreter Required Extension</a></td><td colspan=\"3\"><a href=\"http://snomed.info/id/373066001\">SNOMED CT 373066001</a>: Yes (qualifier value) (version = http://snomed.info/sct/731000124108 )</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The pronouns to use when referring to an individual in verbal or written communication.\">Individual Pronouns:</td><td colspan=\"3\"><ul><li>value: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-NullFlavor UNK}\">Unknown</span></li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"The Sex Extension is used to reflect the documentation of a person's sex. Systems choosing to record sources of information should use the [Provenance resource](basic-provenance.html#element-level-provenance).\n \nUSCDI includes a data element for sex, intended to support the exchange of a sex value that is not characterized as sex assigned at birth or birth sex. This Sex extension supports USCDI. Sex assigned at birth or birth sex can be recorded using the more specific [US Core Birth Sex Extension](StructureDefinition-us-core-birthsex.html).\nFuture versions of this extension may be informed by the content of the HL7 Cross Paradigm IG: Gender Harmony - Sex and Gender Representation, which may include additional guidance on its relationship to administrative gender ([Patient.gender](StructureDefinition-us-core-patient-definitions.html#Patient.gender)).\"><a href=\"StructureDefinition-us-core-sex.html\">US Core Sex Extension</a></td><td colspan=\"3\">248152002</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.\">US Core Ethnicity Extension:</td><td colspan=\"3\"><ul><li>ombCategory: <a href=\"https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238#CDCREC-2135-2\">CDC Race and Ethnicity 2135-2</a>: Hispanic or Latino</li><li>detailed: <a href=\"https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238#CDCREC-2184-0\">CDC Race and Ethnicity 2184-0</a>: Dominican</li><li>detailed: <a href=\"https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238#CDCREC-2148-5\">CDC Race and Ethnicity 2148-5</a>: Mexican</li><li>text: Hispanic or Latino</li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9). After version 6.0.0, this extension is no longer a *USCDI Requirement*.\"><a href=\"StructureDefinition-us-core-birthsex.html\">US Core Birth Sex Extension</a></td><td colspan=\"3\">F</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"A Sex Parameter for Clinical Use is a parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc.. This property is intended for use in clinical decision making, and indicates that treatment or diagnostic tests should consider best practices associated with the relevant reference population. When exchanging these concepts, refer to the guidance in the [Gender Harmony Implementation Guide](http://hl7.org/xprod/ig/uv/gender-harmony/).\">Patient Sex Parameter For Clinical Use:</td><td colspan=\"3\"><ul><li>value: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/data-absent-reason unknown}\">Unknown</span></li><li>supportingInfo: _datatype=CodeableReference; concept=<span title=\"Codes:\">Some Document</span>; reference=some DocumentReference</li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"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](http://www.cdc.gov/phin/resources/vocabulary/index.html#3) 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:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.\">US Core Race Extension:</td><td colspan=\"3\"><ul><li>ombCategory: <a href=\"https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238#CDCREC-2106-3\">CDC Race and Ethnicity 2106-3</a>: White</li><li>ombCategory: <a href=\"https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238#CDCREC-1002-5\">CDC Race and Ethnicity 1002-5</a>: American Indian or Alaska Native</li><li>ombCategory: <a href=\"https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238#CDCREC-2028-9\">CDC Race and Ethnicity 2028-9</a>: Asian</li><li>detailed: <a href=\"https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238#CDCREC-1586-7\">CDC Race and Ethnicity 1586-7</a>: Shoshone</li><li>detailed: <a href=\"https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238#CDCREC-2036-2\">CDC Race and Ethnicity 2036-2</a>: Filipino</li><li>text: Mixed</li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.\">US Core Tribal Affiliation Extension:</td><td colspan=\"3\"><ul><li>tribalAffiliation: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS 187}\">Shoshone</span></li><li>isEnrolled: false</li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.\"><a href=\"StructureDefinition-us-core-genderIdentity.html\">US Core Gender Identity Extension</a></td><td colspan=\"3\"><span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-NullFlavor UNK}\">Unknown</span></td></tr></table></div>"
},
"extension" : [
{
"extension" : [
{
"url" : "ombCategory",
"valueCoding" : {
"system" : "urn:oid:2.16.840.1.113883.6.238",
"code" : "2106-3",
"display" : "White"
}
},
{
"url" : "ombCategory",
"valueCoding" : {
"system" : "urn:oid:2.16.840.1.113883.6.238",
"code" : "1002-5",
"display" : "American Indian or Alaska Native"
}
},
{
"url" : "ombCategory",
"valueCoding" : {
"system" : "urn:oid:2.16.840.1.113883.6.238",
"code" : "2028-9",
"display" : "Asian"
}
},
{
"url" : "detailed",
"valueCoding" : {
"system" : "urn:oid:2.16.840.1.113883.6.238",
"code" : "1586-7",
"display" : "Shoshone"
}
},
{
"url" : "detailed",
"valueCoding" : {
"system" : "urn:oid:2.16.840.1.113883.6.238",
"code" : "2036-2",
"display" : "Filipino"
}
},
{
"url" : "text",
"valueString" : "Mixed"
}
],
"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" : "2135-2",
"display" : "Hispanic or Latino"
}
},
{
"url" : "detailed",
"valueCoding" : {
"system" : "urn:oid:2.16.840.1.113883.6.238",
"code" : "2184-0",
"display" : "Dominican"
}
},
{
"url" : "detailed",
"valueCoding" : {
"system" : "urn:oid:2.16.840.1.113883.6.238",
"code" : "2148-5",
"display" : "Mexican"
}
},
{
"url" : "text",
"valueString" : "Hispanic or Latino"
}
],
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
},
{
"extension" : [
{
"url" : "tribalAffiliation",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
"code" : "187",
"display" : "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
}
],
"text" : "Shoshone"
}
},
{
"url" : "isEnrolled",
"valueBoolean" : false
}
],
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode" : "F"
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
"valueCode" : "248152002"
},
{
"extension" : [
{
"url" : "value",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code" : "unknown",
"display" : "Unknown"
}
],
"text" : "Unknown"
}
},
{
"extension" : [
{
"url" : "_datatype",
"valueString" : "CodeableReference"
},
{
"url" : "concept",
"valueCodeableConcept" : {
"text" : "Some Document"
}
},
{
"url" : "reference",
"valueReference" : {
"display" : "some DocumentReference"
}
}
],
"url" : "supportingInfo"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"
},
{
"extension" : [
{
"url" : "value",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code" : "UNK",
"display" : "Unknown"
}
],
"text" : "Unknown"
}
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/individual-pronouns"
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code" : "UNK",
"display" : "Unknown"
}
],
"text" : "Unknown"
}
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-required",
"valueCoding" : {
"system" : "http://snomed.info/sct",
"version" : "http://snomed.info/sct/731000124108",
"code" : "373066001"
}
}
],
"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" : "1032702"
}
],
"active" : true,
"name" : [
{
"use" : "old",
"family" : "Shaw",
"given" : [
"Amy",
"V."
],
"period" : {
"start" : "2016-12-06",
"end" : "2020-07-22"
}
},
{
"use" : "usual",
"family" : "Baxter",
"given" : [
"Amy",
"V."
],
"suffix" : [
"PharmD"
],
"period" : {
"start" : "2020-07-22"
}
}
],
"telecom" : [
{
"system" : "phone",
"value" : "555-555-5555",
"use" : "home"
},
{
"system" : "email",
"value" : "amy.shaw@example.com"
}
],
"gender" : "female",
"birthDate" : "1987-02-20",
"address" : [
{
"use" : "old",
"line" : [
"49 MEADOW ST"
],
"city" : "MOUNDS",
"state" : "OK",
"postalCode" : "74047",
"country" : "US",
"period" : {
"start" : "2016-12-06",
"end" : "2020-07-22"
}
},
{
"line" : [
"183 MOUNTAIN VIEW ST"
],
"city" : "MOUNDS",
"state" : "OK",
"postalCode" : "74048",
"country" : "US",
"period" : {
"start" : "2020-07-22"
}
}
],
"communication" : [
{
"language" : {
"coding" : [
{
"system" : "urn:ietf:bcp:47",
"code" : "es",
"display" : "Spanish"
}
]
},
"preferred" : true
}
]
}
IG © 2024+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.core#8.0.0-ballot based on FHIR 4.0.1. Generated 2024-11-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change