US Core Implementation Guide
8.0.1 - STU 8

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.1 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

## : Patient Example - JSON Representation

Page standards status: Informative

Raw json | Download

    {
      "resourceType" : "Patient",
      "id" : "example",
      "meta" : {
        "profile" : [
          🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|8.0.1"
        ]
      },
      "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><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-us-core-patient.html\">US Core Patient Profileversion: null8.0.1)</a></p></div><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">Amy V. Baxter  (no stated gender), 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=\"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 [Race &amp; Ethnicity - CDC (CDCREC)](https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238) 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:\n\n   - Hispanic or Latino\n   - Not Hispanic or Latino.\">US Core Ethnicity Extension:</td><td colspan=\"3\"><ul><li>ombCategory: <a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-CDCREC.html#CDCREC-2135-2\">CDC Race and Ethnicity: 2135-2</a> (Hispanic or Latino)</li><li>detailed: <a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-CDCREC.html#CDCREC-2184-0\">CDC Race and Ethnicity: 2184-0</a> (Dominican)</li><li>detailed: <a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-CDCREC.html#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=\"USCDI includes a data element for Sex, intended to support the exchange of a recorded sex value. This extension aligns with the USCDI definition of Sex: &quot;Documentation of a specific instance of sex.&quot; It enables systems to share the sex value as it was documented in a particular context.  Systems choosing to record sources of information should use the [Provenance resource](element-level-provenance.html).\"><a href=\"StructureDefinition-us-core-individual-sex.html\">US Core Individual Sex Extension</a></td><td colspan=\"3\"><a href=\"http://snomed.info/id/248152002\">SNOMED CT: 248152002</a> (Female (finding))</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 [Race &amp; Ethnicity - CDC (CDCREC)](https://phinvads.cdc.gov/vads/ViewCodeSystem.action?id=2.16.840.1.113883.6.238) 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=\"http://terminology.hl7.org/5.5.0/CodeSystem-CDCREC.html#CDCREC-2106-3\">CDC Race and Ethnicity: 2106-3</a> (White)</li><li>ombCategory: <a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-CDCREC.html#CDCREC-1002-5\">CDC Race and Ethnicity: 1002-5</a> (American Indian or Alaska Native)</li><li>ombCategory: <a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-CDCREC.html#CDCREC-2028-9\">CDC Race and Ethnicity: 2028-9</a> (Asian)</li><li>detailed: <a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-CDCREC.html#CDCREC-1586-7\">CDC Race and Ethnicity: 1586-7</a> (Shoshone)</li><li>detailed: <a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-CDCREC.html#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 indicates the individual's need for an interpreter to communicate healthcare information in a language other than the default language of the organization. It has the same meaning as the LOINC [54588-9](https://loinc.org/54588-9) (Interpreter needed)\"><a href=\"StructureDefinition-us-core-interpreter-needed.html\">US Core Interpreter Needed Extension</a></td><td colspan=\"3\"><a href=\"http://snomed.info/id/373066001\">SNOMED CT: 373066001</a> (Yes (qualifier value))</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-individual-sex",
          "valueCoding" : {
            "system" : "http://snomed.info/sct",
            "code" : "248152002",
            "display" : "Female (finding)"
          }
        },
        {
          "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed",
          "valueCoding" : {
            "system" : "http://snomed.info/sct",
            "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://example.org/patient/identifiers",
          "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"
        }
      ],
      "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
        }
      ]
    }