Colorado BHA FHIR Implementation Guide
0.3.0-current - ci-build United States of America flag

Colorado BHA FHIR Implementation Guide, published by Colorado Behavioral Health Administration. This guide is not an authorized publication; it is the continuous build for version 0.3.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CoBHA/CoBHRM-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: BHA Client Profile

Official URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-client Version: 0.3.0-current
Standards status: Trial-use Maturity Level: 1 Computable Name: BHAClient

This profile specifies the mandatory and must support data elements for capturing demographic information for BHA clients in order to support the BHA's annual reporting requirements.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(6.1.0) Information about an individual or animal receiving health care services
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:race This element must be supported. 1..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity This element must be supported. 1..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex This element must be supported. 1..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Patient.Slices for extension.extension:genderIdentity This element must be supported. 0..* CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:USVeteranStatus This element must be supported. 0..1 boolean us-veteran-status
URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:STATE_IDENTIFIER This element must be supported. This element is included in summaries. 0..1 Identifier The client's Colorado PEAK State ID / Universal ID
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "STATE_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER This element must be supported. This element is included in summaries. 0..1 Identifier The client's TRAILS ID
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "TRAILS_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:SSN This element must be supported. This element is included in summaries. 1..1 Identifier The client's Social Security number
Patient.Slices for identifier.identifier:SSN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element must be supported. This element is included in summaries. C 1..* HumanName (USCDI) A name associated with the patient
Slice: Unordered, Open by value:use
Constraints: us-core-6

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.family This element must be supported. This element is included in summaries. C 0..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.given This element must be supported. This element is included in summaries. C 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.suffix This element is included in summaries. 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:officialName This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the Client.
Constraints: us-core-6
Patient.Slices for name.name:officialName.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official (extensions allowed)
Patient.Slices for name.name:officialName.family This element must be supported. This element is included in summaries. C 1..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:officialName.given This element must be supported. This element is included in summaries. C 1..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:officialName.suffix This element must be supported. This element is included in summaries. 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint (USCDI) A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.gender This element must be supported. This element is included in summaries. 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 1..1 date (USCDI) The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 (USCDI) Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.Slices for address This element must be supported. This element is included in summaries. 1..1 Address (USCDI) An address for the individual
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:All Slices Content/Rules for all slices
Patient.Slices for address.address:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for address.address:All Slices.line This element must be supported. This element is included in summaries. 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for address.address:All Slices.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.Slices for address.address:All Slices.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for address.address:All Slices.state This element must be supported. This element is included in summaries. 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
Patient.Slices for address.address:All Slices.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.Slices for address.address:home This element must be supported. This element is included in summaries. 1..1 Address (USCDI) An address for the individual
Patient.Slices for address.address:home.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.line This element must be supported. This element is included in summaries. 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for address.address:home.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.Slices for address.address:home.district This element must be supported. This element is included in summaries. 1..1 string District name (aka county)
Binding: ValueSet for BHA Counties (required)
Example General: Madison
Patient.Slices for address.address:home.state This element must be supported. This element is included in summaries. 1..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
Patient.Slices for address.address:home.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.maritalStatus This element must be supported. 1..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.communication This element must be supported. 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible)
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:STATE_IDENTIFIER.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:STATE_IDENTIFIER.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:TRAILS_IDENTIFIER.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:TRAILS_IDENTIFIER.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:SSN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:officialName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​district Base required ValueSet for BHA Counties 📦0.3.0-current This IG
Patient.address:home.​state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(6.1.0) Information about an individual or animal receiving health care services
Patient.meta
Patient.meta.lastUpdated This element must be supported. 1..1 instant When the resource version last changed
Patient.extension 3..* Extension Extension
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race This element must be supported. 1..1 USCoreRaceExtension(6.1.0) US Core Race Extension
Patient.Slices for extension.extension:ethnicity This element must be supported. 1..1 USCoreEthnicityExtension(6.1.0) US Core ethnicity Extension
Patient.Slices for extension.extension:birthsex This element must be supported. 1..1 USCoreBirthSexExtension(6.1.0) Extension
Patient.Slices for extension.extension:genderIdentity This element must be supported. 0..* USCoreGenderIdentityExtension(6.1.0) Extension
Patient.Slices for extension.extension:USVeteranStatus This element must be supported. 0..1 boolean us-veteran-status
URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
Patient.Slices for identifier.identifier:STATE_IDENTIFIER This element must be supported. 0..1 Identifier The client's Colorado PEAK State ID / Universal ID
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "STATE_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER This element must be supported. 0..1 Identifier The client's TRAILS ID
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "TRAILS_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN This element must be supported. 1..1 Identifier The client's Social Security number
Patient.Slices for identifier.identifier:SSN.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.system 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for name 1..* HumanName (USCDI) A name associated with the patient
Slice: Unordered, Open by value:use
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.family 0..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.given 0..* string (USCDI) Given names (not always 'first'). Includes middle names
Patient.Slices for name.name:All Slices.suffix 0..* string (USCDI) Parts that come after the name
Patient.Slices for name.name:officialName This element must be supported. 1..* HumanName A name associated with the Client.
Patient.Slices for name.name:officialName.use This element must be supported. 1..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Required Pattern: official (extensions allowed)
Patient.Slices for name.name:officialName.family 1..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:officialName.given 1..* string (USCDI) Given names (not always 'first'). Includes middle names
Patient.Slices for name.name:officialName.suffix This element must be supported. 0..* string (USCDI) Parts that come after the name
Patient.birthDate 1..1 date (USCDI) The date of birth for the individual
Patient.Slices for address 1..1 Address (USCDI) An address for the individual
Slice: Unordered, Open by value:use
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:All Slices Content/Rules for all slices
Patient.Slices for address.address:All Slices.line 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
Patient.Slices for address.address:All Slices.city 0..1 string (USCDI) Name of city, town etc.
Patient.Slices for address.address:All Slices.district 0..1 string District name (aka county)
Patient.Slices for address.address:All Slices.postalCode 0..1 string (USCDI) US Zip Codes
Patient.Slices for address.address:home This element must be supported. 1..1 Address (USCDI) An address for the individual
Patient.Slices for address.address:home.use This element must be supported. 1..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.district This element must be supported. 1..1 string District name (aka county)
Binding: ValueSet for BHA Counties (required)
Patient.Slices for address.address:home.state 1..1 string (USCDI) Sub-unit of country (abbreviations ok)
Patient.maritalStatus This element must be supported. 1..1 CodeableConcept Marital (civil) status of a patient
Patient.communication This element must be supported. 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
Patient.communication.language 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.address:home.​district Base required ValueSet for BHA Counties 📦0.3.0-current This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(6.1.0) Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.id 0..1 string Unique id for inter-element referencing
Patient.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Patient.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
Patient.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Patient.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Patient.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:race This element must be supported. 1..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity This element must be supported. 1..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex This element must be supported. 1..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Patient.Slices for extension.extension:genderIdentity This element must be supported. 0..* CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:USVeteranStatus This element must be supported. 0..1 boolean us-veteran-status
URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:All Slices.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:STATE_IDENTIFIER This element must be supported. This element is included in summaries. 0..1 Identifier The client's Colorado PEAK State ID / Universal ID
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "STATE_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER This element must be supported. This element is included in summaries. 0..1 Identifier The client's TRAILS ID
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "TRAILS_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:SSN This element must be supported. This element is included in summaries. 1..1 Identifier The client's Social Security number
Patient.Slices for identifier.identifier:SSN.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:SSN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:SSN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element must be supported. This element is included in summaries. C 1..* HumanName (USCDI) A name associated with the patient
Slice: Unordered, Open by value:use
Constraints: us-core-6

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:All Slices.family This element must be supported. This element is included in summaries. C 0..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.given This element must be supported. This element is included in summaries. C 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.suffix This element is included in summaries. 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.period This element is included in summaries. 0..1 Period (USCDI) Time period when name was/is in use
Patient.Slices for name.name:officialName This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the Client.
Constraints: us-core-6
Patient.Slices for name.name:officialName.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:officialName.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:officialName.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official (extensions allowed)
Patient.Slices for name.name:officialName.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:officialName.family This element must be supported. This element is included in summaries. C 1..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:officialName.given This element must be supported. This element is included in summaries. C 1..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:officialName.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:officialName.suffix This element must be supported. This element is included in summaries. 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:officialName.period This element is included in summaries. 0..1 Period (USCDI) Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint (USCDI) A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element must be supported. This element is included in summaries. 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 1..1 date (USCDI) The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 (USCDI) Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.Slices for address This element must be supported. This element is included in summaries. 1..1 Address (USCDI) An address for the individual
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:All Slices Content/Rules for all slices
Patient.Slices for address.address:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for address.address:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for address.address:All Slices.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for address.address:All Slices.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for address.address:All Slices.line This element must be supported. This element is included in summaries. 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for address.address:All Slices.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.Slices for address.address:All Slices.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for address.address:All Slices.state This element must be supported. This element is included in summaries. 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
Patient.Slices for address.address:All Slices.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.Slices for address.address:All Slices.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for address.address:All Slices.period This element is included in summaries. 0..1 Period (USCDI) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.Slices for address.address:home This element must be supported. This element is included in summaries. 1..1 Address (USCDI) An address for the individual
Patient.Slices for address.address:home.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:home.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for address.address:home.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for address.address:home.line This element must be supported. This element is included in summaries. 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for address.address:home.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.Slices for address.address:home.district This element must be supported. This element is included in summaries. 1..1 string District name (aka county)
Binding: ValueSet for BHA Counties (required)
Example General: Madison
Patient.Slices for address.address:home.state This element must be supported. This element is included in summaries. 1..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
Patient.Slices for address.address:home.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.Slices for address.address:home.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for address.address:home.period This element is included in summaries. 0..1 Period (USCDI) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus This element must be supported. 1..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication This element must be supported. 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible)
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:STATE_IDENTIFIER.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:STATE_IDENTIFIER.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:TRAILS_IDENTIFIER.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:TRAILS_IDENTIFIER.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:SSN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:officialName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:home.​district Base required ValueSet for BHA Counties 📦0.3.0-current This IG
Patient.address:home.​state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCorePatientProfile

Summary

Mandatory: 16 elements(3 nested mandatory elements)
Must-Support: 20 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.name
  • The element 1 is sliced based on the value of Patient.address

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(6.1.0) Information about an individual or animal receiving health care services
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:race This element must be supported. 1..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity This element must be supported. 1..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex This element must be supported. 1..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Patient.Slices for extension.extension:genderIdentity This element must be supported. 0..* CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:USVeteranStatus This element must be supported. 0..1 boolean us-veteran-status
URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:STATE_IDENTIFIER This element must be supported. This element is included in summaries. 0..1 Identifier The client's Colorado PEAK State ID / Universal ID
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "STATE_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER This element must be supported. This element is included in summaries. 0..1 Identifier The client's TRAILS ID
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "TRAILS_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:SSN This element must be supported. This element is included in summaries. 1..1 Identifier The client's Social Security number
Patient.Slices for identifier.identifier:SSN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element must be supported. This element is included in summaries. C 1..* HumanName (USCDI) A name associated with the patient
Slice: Unordered, Open by value:use
Constraints: us-core-6

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.family This element must be supported. This element is included in summaries. C 0..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.given This element must be supported. This element is included in summaries. C 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.suffix This element is included in summaries. 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:officialName This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the Client.
Constraints: us-core-6
Patient.Slices for name.name:officialName.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official (extensions allowed)
Patient.Slices for name.name:officialName.family This element must be supported. This element is included in summaries. C 1..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:officialName.given This element must be supported. This element is included in summaries. C 1..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:officialName.suffix This element must be supported. This element is included in summaries. 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint (USCDI) A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.gender This element must be supported. This element is included in summaries. 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 1..1 date (USCDI) The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 (USCDI) Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.Slices for address This element must be supported. This element is included in summaries. 1..1 Address (USCDI) An address for the individual
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:All Slices Content/Rules for all slices
Patient.Slices for address.address:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for address.address:All Slices.line This element must be supported. This element is included in summaries. 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for address.address:All Slices.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.Slices for address.address:All Slices.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for address.address:All Slices.state This element must be supported. This element is included in summaries. 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
Patient.Slices for address.address:All Slices.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.Slices for address.address:home This element must be supported. This element is included in summaries. 1..1 Address (USCDI) An address for the individual
Patient.Slices for address.address:home.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.line This element must be supported. This element is included in summaries. 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for address.address:home.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.Slices for address.address:home.district This element must be supported. This element is included in summaries. 1..1 string District name (aka county)
Binding: ValueSet for BHA Counties (required)
Example General: Madison
Patient.Slices for address.address:home.state This element must be supported. This element is included in summaries. 1..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
Patient.Slices for address.address:home.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.maritalStatus This element must be supported. 1..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.communication This element must be supported. 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible)
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:STATE_IDENTIFIER.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:STATE_IDENTIFIER.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:TRAILS_IDENTIFIER.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:TRAILS_IDENTIFIER.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:SSN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:officialName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​district Base required ValueSet for BHA Counties 📦0.3.0-current This IG
Patient.address:home.​state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(6.1.0) Information about an individual or animal receiving health care services
Patient.meta
Patient.meta.lastUpdated This element must be supported. 1..1 instant When the resource version last changed
Patient.extension 3..* Extension Extension
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race This element must be supported. 1..1 USCoreRaceExtension(6.1.0) US Core Race Extension
Patient.Slices for extension.extension:ethnicity This element must be supported. 1..1 USCoreEthnicityExtension(6.1.0) US Core ethnicity Extension
Patient.Slices for extension.extension:birthsex This element must be supported. 1..1 USCoreBirthSexExtension(6.1.0) Extension
Patient.Slices for extension.extension:genderIdentity This element must be supported. 0..* USCoreGenderIdentityExtension(6.1.0) Extension
Patient.Slices for extension.extension:USVeteranStatus This element must be supported. 0..1 boolean us-veteran-status
URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
Patient.Slices for identifier 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:STATE_IDENTIFIER This element must be supported. 0..1 Identifier The client's Colorado PEAK State ID / Universal ID
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "STATE_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER This element must be supported. 0..1 Identifier The client's TRAILS ID
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "TRAILS_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN This element must be supported. 1..1 Identifier The client's Social Security number
Patient.Slices for identifier.identifier:SSN.type This element must be supported. 1..1 CodeableConcept Description of identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.system 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for name 1..* HumanName (USCDI) A name associated with the patient
Slice: Unordered, Open by value:use
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.family 0..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.given 0..* string (USCDI) Given names (not always 'first'). Includes middle names
Patient.Slices for name.name:All Slices.suffix 0..* string (USCDI) Parts that come after the name
Patient.Slices for name.name:officialName This element must be supported. 1..* HumanName A name associated with the Client.
Patient.Slices for name.name:officialName.use This element must be supported. 1..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Required Pattern: official (extensions allowed)
Patient.Slices for name.name:officialName.family 1..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:officialName.given 1..* string (USCDI) Given names (not always 'first'). Includes middle names
Patient.Slices for name.name:officialName.suffix This element must be supported. 0..* string (USCDI) Parts that come after the name
Patient.birthDate 1..1 date (USCDI) The date of birth for the individual
Patient.Slices for address 1..1 Address (USCDI) An address for the individual
Slice: Unordered, Open by value:use
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:All Slices Content/Rules for all slices
Patient.Slices for address.address:All Slices.line 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
Patient.Slices for address.address:All Slices.city 0..1 string (USCDI) Name of city, town etc.
Patient.Slices for address.address:All Slices.district 0..1 string District name (aka county)
Patient.Slices for address.address:All Slices.postalCode 0..1 string (USCDI) US Zip Codes
Patient.Slices for address.address:home This element must be supported. 1..1 Address (USCDI) An address for the individual
Patient.Slices for address.address:home.use This element must be supported. 1..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.district This element must be supported. 1..1 string District name (aka county)
Binding: ValueSet for BHA Counties (required)
Patient.Slices for address.address:home.state 1..1 string (USCDI) Sub-unit of country (abbreviations ok)
Patient.maritalStatus This element must be supported. 1..1 CodeableConcept Marital (civil) status of a patient
Patient.communication This element must be supported. 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
Patient.communication.language 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.address:home.​district Base required ValueSet for BHA Counties 📦0.3.0-current This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(6.1.0) Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.id 0..1 string Unique id for inter-element referencing
Patient.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Patient.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
Patient.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Patient.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Patient.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:race This element must be supported. 1..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity This element must be supported. 1..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex This element must be supported. 1..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Patient.Slices for extension.extension:genderIdentity This element must be supported. 0..* CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:USVeteranStatus This element must be supported. 0..1 boolean us-veteran-status
URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:All Slices.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:STATE_IDENTIFIER This element must be supported. This element is included in summaries. 0..1 Identifier The client's Colorado PEAK State ID / Universal ID
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "STATE_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:STATE_IDENTIFIER.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER This element must be supported. This element is included in summaries. 0..1 Identifier The client's TRAILS ID
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://bha.colorado.gov/fhir/bha-ig/CodeSystem/bha-client-identifier-type-cs",
      "code" : "TRAILS_IDENTIFIER"
    }
  ]
}
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:TRAILS_IDENTIFIER.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:SSN This element must be supported. This element is included in summaries. 1..1 Identifier The client's Social Security number
Patient.Slices for identifier.identifier:SSN.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
Patient.Slices for identifier.identifier:SSN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:SSN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element must be supported. This element is included in summaries. C 1..* HumanName (USCDI) A name associated with the patient
Slice: Unordered, Open by value:use
Constraints: us-core-6

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:All Slices.family This element must be supported. This element is included in summaries. C 0..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.given This element must be supported. This element is included in summaries. C 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.suffix This element is included in summaries. 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.period This element is included in summaries. 0..1 Period (USCDI) Time period when name was/is in use
Patient.Slices for name.name:officialName This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the Client.
Constraints: us-core-6
Patient.Slices for name.name:officialName.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:officialName.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:officialName.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official (extensions allowed)
Patient.Slices for name.name:officialName.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:officialName.family This element must be supported. This element is included in summaries. C 1..1 string (USCDI) Family name (often called 'Surname')
Patient.Slices for name.name:officialName.given This element must be supported. This element is included in summaries. C 1..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:officialName.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:officialName.suffix This element must be supported. This element is included in summaries. 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:officialName.period This element is included in summaries. 0..1 Period (USCDI) Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint (USCDI) A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element must be supported. This element is included in summaries. 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 1..1 date (USCDI) The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 (USCDI) Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.Slices for address This element must be supported. This element is included in summaries. 1..1 Address (USCDI) An address for the individual
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for address.address:All Slices Content/Rules for all slices
Patient.Slices for address.address:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for address.address:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for address.address:All Slices.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for address.address:All Slices.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for address.address:All Slices.line This element must be supported. This element is included in summaries. 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for address.address:All Slices.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.Slices for address.address:All Slices.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for address.address:All Slices.state This element must be supported. This element is included in summaries. 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
Patient.Slices for address.address:All Slices.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.Slices for address.address:All Slices.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for address.address:All Slices.period This element is included in summaries. 0..1 Period (USCDI) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.Slices for address.address:home This element must be supported. This element is included in summaries. 1..1 Address (USCDI) An address for the individual
Patient.Slices for address.address:home.id 0..1 string Unique id for inter-element referencing
Patient.Slices for address.address:home.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for address.address:home.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: home (extensions allowed)
Patient.Slices for address.address:home.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for address.address:home.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for address.address:home.line This element must be supported. This element is included in summaries. 0..* string (USCDI) Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for address.address:home.city This element must be supported. This element is included in summaries. 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
Patient.Slices for address.address:home.district This element must be supported. This element is included in summaries. 1..1 string District name (aka county)
Binding: ValueSet for BHA Counties (required)
Example General: Madison
Patient.Slices for address.address:home.state This element must be supported. This element is included in summaries. 1..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
Patient.Slices for address.address:home.postalCode This element must be supported. This element is included in summaries. 0..1 string (USCDI) US Zip Codes
Example General: 9132
Patient.Slices for address.address:home.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for address.address:home.period This element is included in summaries. 0..1 Period (USCDI) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus This element must be supported. 1..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication This element must be supported. 0..* BackboneElement (USCDI) A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible)
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:STATE_IDENTIFIER.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:STATE_IDENTIFIER.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:TRAILS_IDENTIFIER.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:TRAILS_IDENTIFIER.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:SSN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:officialName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.address:home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:home.​district Base required ValueSet for BHA Counties 📦0.3.0-current This IG
Patient.address:home.​state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCorePatientProfile

Summary

Mandatory: 16 elements(3 nested mandatory elements)
Must-Support: 20 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.name
  • The element 1 is sliced based on the value of Patient.address

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron