US Behavioral Health Profiles Implementation Guide
0.1.0 - CI Build
US Behavioral Health Profiles Implementation Guide
0.1.0 - CI Build
This page is part of the US Behavioral Health Profiles (v0.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:Patient ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "bh-patient-example"] ; #
fhir:meta [
( fhir:profile [
fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|6.1.0"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|6.1.0> ] )
] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Patient bh-patient-example</b></p><a name=\"bh-patient-example\"> </a><a name=\"hcbh-patient-example\"> </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=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html\">US Core Patient Profileversion: null6.1.0)</a></p></div><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">James Wolff Male, DoB: 1961-07-16 ( Medical Record Number: 1032702 (use: usual, ))</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"Record is active\">Active:</td><td>true</td><td style=\"background-color: #f3f5da\" title=\"Known status of Patient\">Deceased:</td><td colspan=\"3\">false</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Alternate names (see the one above)\">Alt. Name:</td><td colspan=\"3\">Jennifer Wolff (Official)</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:james.wolff@example.com\">james.wolff@example.com</a></li><li>49 MEADOW ST MIAMI FL 74047 US (old)</li><li>183 MOUNTAIN VIEW ST MIAMI FL 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 en}\">English</span> (preferred)</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"us-veteran-status is a boolean extension used to specify whether a patient was confirmed or verified to have Veteran status. Veteran status is not limited to Combat Status but reflects the status of yes/no they had indeed served in a military organization\"><a href=\"http://hl7.org/fhir/us/military-service/STU1/StructureDefinition-military-service-veteran-status.html\">us-veteran-status</a></td><td colspan=\"3\">true</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).#xA; #xA;USCDI 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).#xA;Future 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=\"http://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-sex.html\">US Core Sex Extension</a></td><td colspan=\"3\">248153007</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=\"http://hl7.org/fhir/us/core/STU3.1.1/CodeSystem-cdcrec.html#cdcrec-2186-5\">Race & Ethnicity - CDC 2186-5</a>: Not Hispanic or Latino</li><li>text: Not 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=\"http://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-birthsex.html\">US Core Birth Sex Extension</a></td><td colspan=\"3\">M</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:#xA;#xA; - American Indian or Alaska Native#xA; - Asian#xA; - Black or African American#xA; - Native Hawaiian or Other Pacific Islander#xA; - White.\">US Core Race Extension:</td><td colspan=\"3\"><ul><li>ombCategory: <a href=\"http://hl7.org/fhir/us/core/STU3.1.1/CodeSystem-cdcrec.html#cdcrec-2054-5\">Race & Ethnicity - CDC 2054-5</a>: Black or African American</li><li>text: Black or African American</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></ul></td></tr></table></div>"^^rdf:XMLLiteral
] ; #
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"^^xsd:anyURI ] ;
( fhir:extension [
fhir:url [ fhir:v "ombCategory"^^xsd:anyURI ] ;
fhir:value [
a fhir:Coding ;
fhir:system [ fhir:v "urn:oid:2.16.840.1.113883.6.238"^^xsd:anyURI ] ;
fhir:code [ fhir:v "2054-5" ] ;
fhir:display [ fhir:v "Black or African American" ] ] ] [
fhir:url [ fhir:v "text"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Black or African American" ] ] )
] [
fhir:url [ fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"^^xsd:anyURI ] ;
( fhir:extension [
fhir:url [ fhir:v "ombCategory"^^xsd:anyURI ] ;
fhir:value [
a fhir:Coding ;
fhir:system [ fhir:v "urn:oid:2.16.840.1.113883.6.238"^^xsd:anyURI ] ;
fhir:code [ fhir:v "2186-5" ] ;
fhir:display [ fhir:v "Not Hispanic or Latino" ] ] ] [
fhir:url [ fhir:v "text"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Not Hispanic or Latino" ] ] )
] [
fhir:url [ fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "M" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "248153007" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
fhir:v true ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"^^xsd:anyURI ] ;
( fhir:extension [
fhir:url [ fhir:v "tribalAffiliation"^^xsd:anyURI ] ;
fhir:value [
a fhir:CodeableConcept ;
( fhir:coding [
fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS"^^xsd:anyURI ] ;
fhir:code [ fhir:v "187" ] ;
fhir:display [ fhir:v "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada" ] ] ) ;
fhir:text [ fhir:v "Shoshone" ] ] ] )
] ) ; # Race
fhir:identifier ( [
fhir:use [ fhir:v "usual" ] ;
fhir:type [
( fhir:coding [
fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/v2-0203"^^xsd:anyURI ] ;
fhir:code [ fhir:v "MR" ] ;
fhir:display [ fhir:v "Medical Record Number" ] ] ) ;
fhir:text [ fhir:v "Medical Record Number" ] ] ;
fhir:system [ fhir:v "http://hospital.smarthealthit.org"^^xsd:anyURI ] ;
fhir:value [ fhir:v "1032702" ]
] ) ; #
fhir:active [ fhir:v true] ; #
fhir:name ( [
fhir:use [ fhir:v "official" ] ;
fhir:family [ fhir:v "Wolff" ] ;
( fhir:given [ fhir:v "Jennifer" ] )
] [
fhir:use [ fhir:v "usual" ] ;
fhir:family [ fhir:v "Wolff" ] ;
( fhir:given [ fhir:v "James" ] ) ;
fhir:period [
fhir:start [ fhir:v "2016-07-22"^^xsd:date ] ]
] ) ; # Legal name
fhir:telecom ( [
fhir:system [ fhir:v "phone" ] ;
fhir:value [ fhir:v "555-555-5555" ] ;
fhir:use [ fhir:v "home" ]
] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "james.wolff@example.com" ]
] ) ; #
fhir:gender [ fhir:v "male"] ; # Administrative Gender, used for administrative purposes
fhir:birthDate [ fhir:v "1961-07-16"^^xsd:date] ; #
fhir:deceased [
a fhir:boolean ;
fhir:v false
] ; #
fhir:address ( [
fhir:use [ fhir:v "old" ] ;
( fhir:line [ fhir:v "49 MEADOW ST" ] ) ;
fhir:city [ fhir:v "MIAMI" ] ;
fhir:state [ fhir:v "FL" ] ;
fhir:postalCode [ fhir:v "74047" ] ;
fhir:country [ fhir:v "US" ] ;
fhir:period [
fhir:start [ fhir:v "2016-12-06"^^xsd:date ] ;
fhir:end [ fhir:v "2020-07-22"^^xsd:date ] ]
] [
( fhir:line [ fhir:v "183 MOUNTAIN VIEW ST" ] ) ;
fhir:city [ fhir:v "MIAMI" ] ;
fhir:state [ fhir:v "FL" ] ;
fhir:postalCode [ fhir:v "74048" ] ;
fhir:country [ fhir:v "US" ] ;
fhir:period [
fhir:start [ fhir:v "2020-07-22"^^xsd:date ] ]
] ) ; #
fhir:communication ( [
fhir:language [
( fhir:coding [
fhir:system [ fhir:v "urn:ietf:bcp:47"^^xsd:anyURI ] ;
fhir:code [ fhir:v "en" ] ;
fhir:display [ fhir:v "English" ] ] ) ;
fhir:text [ fhir:v "English" ] ] ;
fhir:preferred [ fhir:v true ]
] ) . #
IG © 2020+ ASTP / BHIT. Package fhir.astp.bhp#0.1.0 based on FHIR 4.0.1. Generated 2025-08-18
Links: Table of Contents |
License |
QA Report
| New Issue | Issues
| Version History |