Colorado BHA FHIR Implementation Guide
0.1.0-current - ci-build Unknown region code '840'

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.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RatioPBC/bha-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Colorado BHA Client Profile

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

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

Usages:

- Examples for this Profile: Patient/BHAClientExample

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:race |  | 0..1 | (Complex) | (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
extension:birthsex |  | 0..1 | code | Birth Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
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.
extension:genderIdentity |  | 0..* | CodeableConcept | (USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:bharace |  | 1..1 | CodeableConcept | BHA race code URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-race Binding: BHA Race Value Set (required)
extension:USVeteranStatus | S | 0..1 | boolean | us-veteran-status URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456
identifier:SSN | S Σ | 0..1 | Identifier | The client's Social Security number
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
value | S Σ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ C | 1..* | HumanName | A name associated with the Client. Constraints: us-core-6
use | ?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | S Σ C | 0..1 | string | (USCDI) Family name (often called 'Surname')
given | S Σ 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
telecom | Σ | 0..* | ContactPoint | (USCDI) A contact detail for the individual
system | S Σ C | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | (USCDI) The actual contact point details
use | ?!S Σ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
gender | S Σ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 1..1 | date | (USCDI) The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | (USCDI) Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | (USCDI) An address for the individual
use | ?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 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
city | S Σ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon
district | S Σ | 1..1 | string | District name (aka county) Binding: BHA Counties Value Set (required) Example General: Madison
state | S Σ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 1..1 | string | (USCDI) US Zip Codes Example General: 9132
maritalStatus | S | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
communication |  | 0..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | S | 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)
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
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: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.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.district | Base | required | BHA Counties Value Set | 📦0.1.0-current | This IG
Patient.address.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
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
us-core-6 | error | Patient.name | At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. | `(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`

This structure is derived from USCorePatientProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:bharace |  | 1..1 | CodeableConcept | BHA race code URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-race Binding: BHA Race Value Set (required)
extension:USVeteranStatus | S | 0..1 | boolean | us-veteran-status URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
Slices for identifier |  | 1..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:SSN | S | 0..1 | Identifier | The client's Social Security number
type |  | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS
system |  | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
name |  | 1..* | HumanName | A name associated with the Client.
birthDate |  | 1..1 | date | (USCDI) The date of birth for the individual
address |  |  |  |
district | S | 1..1 | string | District name (aka county) Binding: BHA Counties Value Set (required)
postalCode |  | 1..1 | string | (USCDI) US Zip Codes
maritalStatus | S | 1..1 | CodeableConcept | Marital (civil) status of a patient
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.address.district | Base | required | BHA Counties Value Set | 📦0.1.0-current | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:race |  | 0..1 | (Complex) | (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
extension:birthsex |  | 0..1 | code | Birth Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
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.
extension:genderIdentity |  | 0..* | CodeableConcept | (USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:bharace |  | 1..1 | CodeableConcept | BHA race code URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-race Binding: BHA Race Value Set (required)
extension:USVeteranStatus | S | 0..1 | boolean | us-veteran-status URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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.
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:SSN | S Σ | 0..1 | Identifier | The client's Social Security number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
value | S Σ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ C | 1..* | HumanName | A name associated with the Client. Constraints: us-core-6
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | S Σ C | 0..1 | string | (USCDI) Family name (often called 'Surname')
given | S Σ 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
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | (USCDI) Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | (USCDI) Time period when name was/is in use
telecom | Σ | 0..* | ContactPoint | (USCDI) A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | (USCDI) The actual contact point details
use | ?!S Σ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 1..1 | date | (USCDI) The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | (USCDI) Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | (USCDI) An address for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 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
city | S Σ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon
district | S Σ | 1..1 | string | District name (aka county) Binding: BHA Counties Value Set (required) Example General: Madison
state | S Σ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 1..1 | string | (USCDI) US Zip Codes Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus | S | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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.
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | S | 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)
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
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: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.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.district | Base | required | BHA Counties Value Set | 📦0.1.0-current | This IG
Patient.address.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
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization | `name.exists() or telecom.exists() or address.exists() or organization.exists()`
us-core-6 | error | Patient.name | At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. | `(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`

This structure is derived from USCorePatientProfile

Summary

Mandatory: 4 elements(3 nested mandatory elements)
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

- http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-race
- http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.identifier

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:race |  | 0..1 | (Complex) | (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
extension:birthsex |  | 0..1 | code | Birth Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
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.
extension:genderIdentity |  | 0..* | CodeableConcept | (USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:bharace |  | 1..1 | CodeableConcept | BHA race code URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-race Binding: BHA Race Value Set (required)
extension:USVeteranStatus | S | 0..1 | boolean | us-veteran-status URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456
identifier:SSN | S Σ | 0..1 | Identifier | The client's Social Security number
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
value | S Σ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ C | 1..* | HumanName | A name associated with the Client. Constraints: us-core-6
use | ?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family | S Σ C | 0..1 | string | (USCDI) Family name (often called 'Surname')
given | S Σ 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
telecom | Σ | 0..* | ContactPoint | (USCDI) A contact detail for the individual
system | S Σ C | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | (USCDI) The actual contact point details
use | ?!S Σ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
gender | S Σ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 1..1 | date | (USCDI) The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | (USCDI) Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | (USCDI) An address for the individual
use | ?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 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
city | S Σ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon
district | S Σ | 1..1 | string | District name (aka county) Binding: BHA Counties Value Set (required) Example General: Madison
state | S Σ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 1..1 | string | (USCDI) US Zip Codes Example General: 9132
maritalStatus | S | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
communication |  | 0..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | S | 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)
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
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: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.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.district | Base | required | BHA Counties Value Set | 📦0.1.0-current | This IG
Patient.address.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
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
us-core-6 | error | Patient.name | At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. | `(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`

Differential View

This structure is derived from USCorePatientProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:bharace |  | 1..1 | CodeableConcept | BHA race code URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-race Binding: BHA Race Value Set (required)
extension:USVeteranStatus | S | 0..1 | boolean | us-veteran-status URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
Slices for identifier |  | 1..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:SSN | S | 0..1 | Identifier | The client's Social Security number
type |  | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS
system |  | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
name |  | 1..* | HumanName | A name associated with the Client.
birthDate |  | 1..1 | date | (USCDI) The date of birth for the individual
address |  |  |  |
district | S | 1..1 | string | District name (aka county) Binding: BHA Counties Value Set (required)
postalCode |  | 1..1 | string | (USCDI) US Zip Codes
maritalStatus | S | 1..1 | CodeableConcept | Marital (civil) status of a patient
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.address.district | Base | required | BHA Counties Value Set | 📦0.1.0-current | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:race |  | 0..1 | (Complex) | (USCDI) US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity |  | 0..1 | (Complex) | (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:tribalAffiliation |  | 0..* | (Complex) | (USCDI) Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
extension:birthsex |  | 0..1 | code | Birth Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
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.
extension:genderIdentity |  | 0..* | CodeableConcept | (USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:bharace |  | 1..1 | CodeableConcept | BHA race code URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-race Binding: BHA Race Value Set (required)
extension:USVeteranStatus | S | 0..1 | boolean | us-veteran-status URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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.
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:SSN | S Σ | 0..1 | Identifier | The client's Social Security number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | S Σ | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
value | S Σ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ C | 1..* | HumanName | A name associated with the Client. Constraints: us-core-6
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | S Σ C | 0..1 | string | (USCDI) Family name (often called 'Surname')
given | S Σ 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
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | (USCDI) Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | (USCDI) Time period when name was/is in use
telecom | Σ | 0..* | ContactPoint | (USCDI) A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | (USCDI) The actual contact point details
use | ?!S Σ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 1..1 | date | (USCDI) The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | (USCDI) Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | (USCDI) An address for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 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
city | S Σ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon
district | S Σ | 1..1 | string | District name (aka county) Binding: BHA Counties Value Set (required) Example General: Madison
state | S Σ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 1..1 | string | (USCDI) US Zip Codes Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus | S | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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.
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language | S | 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)
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
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: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.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.district | Base | required | BHA Counties Value Set | 📦0.1.0-current | This IG
Patient.address.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
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization | `name.exists() or telecom.exists() or address.exists() or organization.exists()`
us-core-6 | error | Patient.name | At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. | `(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`

This structure is derived from USCorePatientProfile

Summary

Mandatory: 4 elements(3 nested mandatory elements)
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

- http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-race
- http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-veteran-status

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.identifier

Maturity: 0

Other representations of profile: CSV, Excel, Schematron