CARIN Digital Insurance Card
2.0.0 - STU 2.0
CARIN Digital Insurance Card
2.0.0 - STU 2.0
CARIN Digital Insurance Card, published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-digital-insurance-card/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient | Version: 2.0.0 | |||
| Active as of 2025-10-10 | Computable Name: C4DICPatient | |||
The goal of this profile is to describe a data-minimized version of Patient used to convey information about the Member who has health insurance coverage. Information that would normally not appear on a health insurance card is not required. The use of this profile is only approved for conveying information related to a health insurance card as part of this IG.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePatientProfile
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Patient |
0..* | USCorePatientProfile(7.0.0) | Information about an individual who has health insurance coverage | |
  meta |
S | 1..1 | Meta | Metadata about the resource |
  lastUpdated |
S | 1..1 | instant | When the resource version last changed |
  Slices for profile |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | |
   profile:supportedProfile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient | |
| name |
1..1 | HumanName | A name associated with the patient | |
 family |
1..1 | string | Family name (often called 'Surname') | |
| gender |
1..1 | code | male | female | other | unknown | |
| birthDate |
0..1 | date | The date of birth for the individual | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | USCorePatientProfile(7.0.0) | Information about an individual who has health insurance coverage | |
 meta |
SΣ | 1..1 | Meta | Metadata about the resource |
 lastUpdated |
SΣ | 1..1 | instant | When the resource version last changed |
| Slices for profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this |
| profile:supportedProfile |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
 extension:race |
C | 0..1 | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23 |
| extension:ethnicity |
0..1 | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
| extension:tribalAffiliation |
0..* | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (extensible): Concepts used for general documentation of sex representation | |
| extension:genderIdentity |
0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..* | Identifier | An identifier for this patient |
| 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 | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | 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..1 | HumanName | A name associated with the patient Constraints: us-core-6 |
| use |
?!Σ | 0..1 | code | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| family |
SΣC | 1..1 | string | Family name (often called 'Surname') |
| given |
SΣC | 0..* | string | 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual |
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
SΣ | 1..1 | string | The actual contact point details |
| use |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| gender |
SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate |
SΣ | 0..1 | date | The date of birth for the individual |
 deceased[x] |
?!Σ | 0..1 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not | |
| deceasedBoolean |
boolean | |||
| deceasedDateTime |
dateTime | |||
| address |
SΣ | 0..* | Address | An address for the individual |
| use |
?!Σ | 0..1 | code | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line |
SΣ | 0..* | string | 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 Example General: 49 MEADOW ST |
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN |
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example General: OK |
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 |
| communication |
0..* | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier.use | Base | required | IdentifierUse | 📍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.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦7.0.0 | US Core v7.0 |
| Patient.communication.language | Base | extensible | Language codes with language and optionally a region modifier | 📦7.0.0 | US Core v7.0 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| 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()
|
| us-core-23 | error | Patient.extension:race | If "ASKU" or "UNK" are present, then no other OMB race categories can be present. |
extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | USCorePatientProfile(7.0.0) | Information about an individual who has health insurance coverage | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
SΣ | 1..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
SΣ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | ||||
| profile:supportedProfile |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 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". | ||||
| 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.
| |||||
| 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 |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:race |
C | 0..1 | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23 | ||||
| extension:ethnicity |
0..1 | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
| extension:tribalAffiliation |
0..* | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (extensible): Concepts used for general documentation of sex representation | |||||
| extension:genderIdentity |
0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..* | Identifier | An identifier for this patient | ||||
| 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 | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | 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..1 | HumanName | A name associated with the patient 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | 1..1 | string | Family name (often called 'Surname') | ||||
| given |
SΣC | 0..* | string | 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use | ||||
| telecom |
Σ | 0..* | ContactPoint | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 0..1 | code | 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 | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
| birthDate |
SΣ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] |
?!Σ | 0..1 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| address |
SΣ | 0..* | Address | 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | 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 Example General: 49 MEADOW ST | ||||
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN | ||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example General: OK | ||||
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 | ||||
| country |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period |
Σ | 0..1 | Period | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus |
0..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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (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 | ||||||||
| 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.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.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦7.0.0 | US Core v7.0 |
| 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 | 📦7.0.0 | US Core v7.0 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| 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()
|
| us-core-23 | error | Patient.extension:race | If "ASKU" or "UNK" are present, then no other OMB race categories can be present. |
extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1
|
This structure is derived from USCorePatientProfile
Summary
Mandatory: 5 elements
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCorePatientProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | USCorePatientProfile(7.0.0) | Information about an individual who has health insurance coverage | |
| meta |
S | 1..1 | Meta | Metadata about the resource |
| lastUpdated |
S | 1..1 | instant | When the resource version last changed |
| Slices for profile |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | |
| profile:supportedProfile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient | |
| name |
1..1 | HumanName | A name associated with the patient | |
| family |
1..1 | string | Family name (often called 'Surname') | |
| gender |
1..1 | code | male | female | other | unknown | |
| birthDate |
0..1 | date | The date of birth for the individual | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | USCorePatientProfile(7.0.0) | Information about an individual who has health insurance coverage | |
| meta |
SΣ | 1..1 | Meta | Metadata about the resource |
| lastUpdated |
SΣ | 1..1 | instant | When the resource version last changed |
| Slices for profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this |
| profile:supportedProfile |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:race |
C | 0..1 | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23 |
| extension:ethnicity |
0..1 | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
| extension:tribalAffiliation |
0..* | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (extensible): Concepts used for general documentation of sex representation | |
| extension:genderIdentity |
0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..* | Identifier | An identifier for this patient |
| 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 | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | 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..1 | HumanName | A name associated with the patient Constraints: us-core-6 |
| use |
?!Σ | 0..1 | code | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| family |
SΣC | 1..1 | string | Family name (often called 'Surname') |
| given |
SΣC | 0..* | string | 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual |
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
SΣ | 1..1 | string | The actual contact point details |
| use |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| gender |
SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate |
SΣ | 0..1 | date | The date of birth for the individual |
| deceased[x] |
?!Σ | 0..1 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not | |
| deceasedBoolean |
boolean | |||
| deceasedDateTime |
dateTime | |||
| address |
SΣ | 0..* | Address | An address for the individual |
| use |
?!Σ | 0..1 | code | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line |
SΣ | 0..* | string | 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 Example General: 49 MEADOW ST |
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN |
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example General: OK |
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 |
| communication |
0..* | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier.use | Base | required | IdentifierUse | 📍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.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦7.0.0 | US Core v7.0 |
| Patient.communication.language | Base | extensible | Language codes with language and optionally a region modifier | 📦7.0.0 | US Core v7.0 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| 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()
|
| us-core-23 | error | Patient.extension:race | If "ASKU" or "UNK" are present, then no other OMB race categories can be present. |
extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | USCorePatientProfile(7.0.0) | Information about an individual who has health insurance coverage | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
SΣ | 1..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
SΣ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | ||||
| profile:supportedProfile |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 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". | ||||
| 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.
| |||||
| 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 |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:race |
C | 0..1 | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23 | ||||
| extension:ethnicity |
0..1 | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
| extension:tribalAffiliation |
0..* | (Complex) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (extensible): Concepts used for general documentation of sex representation | |||||
| extension:genderIdentity |
0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..* | Identifier | An identifier for this patient | ||||
| 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 | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | 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..1 | HumanName | A name associated with the patient 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | 1..1 | string | Family name (often called 'Surname') | ||||
| given |
SΣC | 0..* | string | 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use | ||||
| telecom |
Σ | 0..* | ContactPoint | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!SΣ | 0..1 | code | 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 | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
| birthDate |
SΣ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] |
?!Σ | 0..1 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| address |
SΣ | 0..* | Address | 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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | 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 Example General: 49 MEADOW ST | ||||
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN | ||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. Example General: OK | ||||
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 | ||||
| country |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period |
Σ | 0..1 | Period | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus |
0..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 | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (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 | ||||||||
| 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.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.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦7.0.0 | US Core v7.0 |
| 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 | 📦7.0.0 | US Core v7.0 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| 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()
|
| us-core-23 | error | Patient.extension:race | If "ASKU" or "UNK" are present, then no other OMB race categories can be present. |
extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1
|
This structure is derived from USCorePatientProfile
Summary
Mandatory: 5 elements
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Payer/Provider Information Exchange Work Group. Package hl7.fhir.us.insurance-card#2.0.0 based on FHIR 4.0.1. Generated 2025-10-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change