US Public Health Profiles Library
2.0.0 -
US Public Health Profiles Library, published by HL7 International / Public Health. 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/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-23 | Maturity Level: 3 | Computable Name: USPublicHealthPatient | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.42 | ||||
This Patient profile represents a US Public Health Patient.
It is based on the US Core Patient profile and further constrains it as follows:
If the patient is homeless, complete as much Patient.address information as possible (city, zip, county, etc.) and use the Characteristics of Home Environment profile to indicate that the patient is homeless.
| Use Case | Data Class | Data Element Name |
|---|---|---|
| Case Reporting | Patient Demographics | Current Address |
| Case Reporting | Patient Demographics | Date of Birth |
| Case Reporting | Patient Demographics | Date of Death |
| Case Reporting | Patient Demographics | Email Address |
| Case Reporting | Patient Demographics | Ethnicity |
| Case Reporting | Patient Demographics | Medical Record Number |
| Case Reporting | Patient Demographics | Medicare Patient Identifier |
| Case Reporting | Patient Demographics | Parent/Guardian Name |
| Case Reporting | Patient Demographics | Patient Birth Place |
| Case Reporting | Patient Demographics | Patient Name |
| Case Reporting | Patient Demographics | Patient Identifier |
| Case Reporting | Patient Demographics | Patient Vital Status |
| Case Reporting | Patient Demographics | Phone Number |
| Case Reporting | Patient Demographics | Preferred Language |
| Case Reporting | Patient Demographics | Race |
| Case Reporting | Patient Demographics | Related Person's Email |
| Case Reporting | Patient Demographics | Related Person's Phone Number |
| Case Reporting | Patient Demographics | Relationship Type |
| Case Reporting | Patient Demographics | Tribal Affiliation |
| Case Reporting | Patient Demographics | Tribal Enrollment |
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePatientProfile(6.1.0) | US Public Health Patient | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | (USCDI+) Race (US Core Race Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: ext-1 |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
S | 0..5 | Extension | (USCDI) American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ombCategory" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: OmbRaceCategories (6.1.0) (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997. | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extended race codes Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "detailed" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: DetailedRace (6.1.0) (required) | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | (USCDI) Race Text Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "text" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | (USCDI+) Ethnicity (US Core Ethnicity Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Constraints: ext-1 |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | (USCDI) Hispanic or Latino|Not Hispanic or Latino Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ombCategory" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: OmbEthnicityCategories (6.1.0) (required) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extended ethnicity codes Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "detailed" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: DetailedEthnicity (6.1.0) (required) | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | (USCDI) ethnicity Text Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "text" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity" | |
![]() ![]() ![]() |
S | 0..* | (Complex) | (USCDI+) Tribal Affiliation, (USCDI+) Tribal Enrollment (US Core Tribal Affiliation Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation Constraints: ext-1 |
![]() ![]() ![]() |
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 Constraints: ext-1 | |
![]() ![]() ![]() |
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.Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | CodeableConcept | (USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)Constraints: ext-1 | |
![]() ![]() ![]() |
S | 0..1 | Address | (USCDI+) Patient Birth Place (FHIR Patient Birth Place Extension) URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace Constraints: ext-1 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣ | 1..* | Identifier | (USCDI+) Patient Identifier, (USCDI+) Medical Record Number, (USCDI+) Medicare Patient Identifier |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() |
SΣC | 1..* | HumanName | (USCDI+) Patient Name Constraints: us-core-6 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() |
SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') |
![]() ![]() ![]() |
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 |
![]() ![]() |
SΣ | 1..* | ContactPoint | (USCDI) A contact detail for the individual Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | (USCDI+) Phone Number |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | (USCDI+) Email Address |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() |
SΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() |
SΣ | 1..1 | date | (USCDI+) Date of Birth |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() |
?!SΣ | 1..1 | If patient is deceased, use type dateTime and set to deceased date. | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
SΣ | 1..* | Address | (USCDI+) Current Address |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 0..1 | string | County Example General: Madison |
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes. |
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 |
![]() ![]() |
SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Relationship Type, Parent/Guardian Code Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. |
![]() ![]() ![]() |
S | 1..1 | HumanName | (USCDI+) Parent/Guardian Name |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() |
S | 1..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() |
S | 1..1 | Address | Parent/Guardian Address |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() |
S | 1..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Preferred Language Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() |
Σ | 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.extension:race.extension:ombCategory.value[x] | Base | required | OMB Race Categories | 📍6.1.0 | US Core v6.1 |
| Patient.extension:race.extension:detailed.value[x] | Base | required | Detailed Race | 📍6.1.0 | US Core v6.1 |
| Patient.extension:race.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.extension:ethnicity.extension:ombCategory.value[x] | Base | required | OMB Ethnicity Categories | 📍6.1.0 | US Core v6.1 |
| Patient.extension:ethnicity.extension:detailed.value[x] | Base | required | Detailed ethnicity | 📍6.1.0 | US Core v6.1 |
| Patient.extension:ethnicity.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.identifier.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.name.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍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.telecom:phone.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.gender.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.birthDate.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.address.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1 |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.use | Base | required | AddressUse | 📍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.communication.language.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| 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 | Patient.implicitRules, Patient.extension, Patient.extension:race, Patient.extension:race.extension, Patient.extension:race.extension:ombCategory, Patient.extension:race.extension:ombCategory.value[x], Patient.extension:race.extension:detailed, Patient.extension:race.extension:detailed.value[x], Patient.extension:race.extension:text, Patient.extension:race.extension:text.value[x], Patient.extension:race.extension:dataAbsentReason, Patient.extension:race.extension:dataAbsentReason.value[x], Patient.extension:ethnicity, Patient.extension:ethnicity.extension, Patient.extension:ethnicity.extension:ombCategory, Patient.extension:ethnicity.extension:ombCategory.value[x], Patient.extension:ethnicity.extension:detailed, Patient.extension:ethnicity.extension:detailed.value[x], Patient.extension:ethnicity.extension:text, Patient.extension:ethnicity.extension:text.value[x], Patient.extension:ethnicity.extension:dataAbsentReason, Patient.extension:ethnicity.extension:dataAbsentReason.value[x], Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:birthPlace, Patient.modifierExtension, Patient.identifier, Patient.identifier.extension:dataAbsentReason, Patient.identifier.extension:dataAbsentReason.value[x], Patient.identifier.use, Patient.identifier.system, Patient.identifier.value, Patient.active, Patient.name, Patient.name.extension:dataAbsentReason, Patient.name.extension:dataAbsentReason.value[x], Patient.name.use, Patient.name.family, Patient.name.given, Patient.telecom, Patient.telecom.extension:dataAbsentReason, Patient.telecom.extension:dataAbsentReason.value[x], Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom:phone, Patient.telecom:phone.extension:dataAbsentReason, Patient.telecom:phone.extension:dataAbsentReason.value[x], Patient.telecom:phone.system, Patient.telecom:phone.value, Patient.telecom:phone.use, Patient.telecom:email, Patient.telecom:email.extension:dataAbsentReason, Patient.telecom:email.extension:dataAbsentReason.value[x], Patient.telecom:email.system, Patient.telecom:email.value, Patient.telecom:email.use, Patient.gender, Patient.gender.extension, Patient.gender.extension:dataAbsentReason, Patient.gender.extension:dataAbsentReason.value[x], Patient.birthDate, Patient.birthDate.extension, Patient.birthDate.extension:dataAbsentReason, Patient.birthDate.extension:dataAbsentReason.value[x], Patient.deceased[x], Patient.address, Patient.address.extension:dataAbsentReason, Patient.address.extension:dataAbsentReason.value[x], Patient.address.use, Patient.address.line, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.contact, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.name.extension:dataAbsentReason, Patient.contact.name.extension:dataAbsentReason.value[x], Patient.contact.name.use, Patient.contact.telecom, Patient.contact.telecom.extension:dataAbsentReason, Patient.contact.telecom.extension:dataAbsentReason.value[x], Patient.contact.telecom.use, Patient.contact.address, Patient.contact.address.extension:dataAbsentReason, Patient.contact.address.extension:dataAbsentReason.value[x], Patient.contact.address.use, Patient.communication, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.language.extension:dataAbsentReason, Patient.communication.language.extension:dataAbsentReason.value[x], Patient.link, Patient.link.modifierExtension, Patient.link.other, Patient.link.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Patient.extension, Patient.extension:race, Patient.extension:race.extension, Patient.extension:race.extension:ombCategory, Patient.extension:race.extension:detailed, Patient.extension:race.extension:text, Patient.extension:race.extension:dataAbsentReason, Patient.extension:ethnicity, Patient.extension:ethnicity.extension, Patient.extension:ethnicity.extension:ombCategory, Patient.extension:ethnicity.extension:detailed, Patient.extension:ethnicity.extension:text, Patient.extension:ethnicity.extension:dataAbsentReason, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:birthPlace, Patient.modifierExtension, Patient.identifier.extension:dataAbsentReason, Patient.name.extension:dataAbsentReason, Patient.telecom.extension:dataAbsentReason, Patient.telecom:phone.extension:dataAbsentReason, Patient.telecom:email.extension:dataAbsentReason, Patient.gender.extension, Patient.gender.extension:dataAbsentReason, Patient.birthDate.extension, Patient.birthDate.extension:dataAbsentReason, Patient.address.extension:dataAbsentReason, Patient.contact.modifierExtension, Patient.contact.name.extension:dataAbsentReason, Patient.contact.telecom.extension:dataAbsentReason, Patient.contact.address.extension:dataAbsentReason, Patient.communication.modifierExtension, Patient.communication.language.extension:dataAbsentReason, Patient.link.modifierExtension | 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePatientProfile(6.1.0) | US Public Health Patient | |
![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | USCoreRaceExtension(6.1.0) | (USCDI+) Race (US Core Race Extension) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 1..1 | USCoreEthnicityExtension(6.1.0) | (USCDI+) Ethnicity (US Core Ethnicity Extension) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 0..* | USCoreTribalAffiliationExtension(6.1.0) | (USCDI+) Tribal Affiliation, (USCDI+) Tribal Enrollment (US Core Tribal Affiliation Extension) |
![]() ![]() ![]() |
S | 0..1 | Address | (USCDI+) Patient Birth Place (FHIR Patient Birth Place Extension) URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
![]() ![]() |
1..* | Identifier | (USCDI+) Patient Identifier, (USCDI+) Medical Record Number, (USCDI+) Medicare Patient Identifier | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
1..* | HumanName | (USCDI+) Patient Name | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
S | 1..* | ContactPoint | (USCDI) A contact detail for the individual Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 0..* | ContactPoint | (USCDI+) Phone Number |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
![]() ![]() ![]() ![]() |
1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Fixed Value: phone | |
![]() ![]() ![]() |
S | 0..* | ContactPoint | (USCDI+) Email Address |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
![]() ![]() ![]() ![]() |
1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Fixed Value: email | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
1..1 | date | (USCDI+) Date of Birth | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
S | 1..1 | boolean, dateTime | If patient is deceased, use type dateTime and set to deceased date. |
![]() ![]() |
1..* | Address | (USCDI+) Current Address | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 0..1 | string | County |
![]() ![]() |
S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Relationship Type, Parent/Guardian Code |
![]() ![]() ![]() |
S | 1..1 | HumanName | (USCDI+) Parent/Guardian Name |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 1..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 1..1 | Address | Parent/Guardian Address |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
S | 1..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() |
1..1 | CodeableConcept | (USCDI+) Preferred Language | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCorePatientProfile(6.1.0) | US Public Health Patient | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | (USCDI+) Race (US Core Race Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..5 | Extension | (USCDI) American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ombCategory" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: OmbRaceCategories (6.1.0) (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extended race codes Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "detailed" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: DetailedRace (6.1.0) (required) | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | (USCDI) Race Text Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "text" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" | |||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | (USCDI+) Ethnicity (US Core Ethnicity Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | (USCDI) Hispanic or Latino|Not Hispanic or Latino Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ombCategory" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: OmbEthnicityCategories (6.1.0) (required) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extended ethnicity codes Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "detailed" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: DetailedEthnicity (6.1.0) (required) | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | (USCDI) ethnicity Text Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "text" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity" | |||||
![]() ![]() ![]() |
S | 0..* | (Complex) | (USCDI+) Tribal Affiliation, (USCDI+) Tribal Enrollment (US Core Tribal Affiliation Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation Constraints: ext-1 | ||||
![]() ![]() ![]() |
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 Constraints: ext-1 | |||||
![]() ![]() ![]() |
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.Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | (USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)Constraints: ext-1 | |||||
![]() ![]() ![]() |
S | 0..1 | Address | (USCDI+) Patient Birth Place (FHIR Patient Birth Place Extension) URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace Constraints: ext-1 | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣ | 1..* | Identifier | (USCDI+) Patient Identifier, (USCDI+) Medical Record Number, (USCDI+) Medicare Patient Identifier | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() |
SΣC | 1..* | HumanName | (USCDI+) Patient Name Constraints: us-core-6 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | (USCDI) Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | (USCDI) Time period when name was/is in use | ||||
![]() ![]() |
SΣ | 1..* | ContactPoint | (USCDI) A contact detail for the individual Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | (USCDI+) Phone Number | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | (USCDI+) Email Address | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required) | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() |
SΣ | 1..1 | date | (USCDI+) Date of Birth | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||
![]() ![]() |
?!SΣ | 1..1 | If patient is deceased, use type dateTime and set to deceased date. | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
SΣ | 1..* | Address | (USCDI+) Current Address | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | County Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Relationship Type, Parent/Guardian Code Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | ||||
![]() ![]() ![]() |
S | 1..1 | HumanName | (USCDI+) Parent/Guardian Name | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
S | 1..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 1..1 | Address | Parent/Guardian Address | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
S | 1..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Preferred Language Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() |
Σ | 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.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.extension:race.extension:ombCategory.value[x] | Base | required | OMB Race Categories | 📍6.1.0 | US Core v6.1 |
| Patient.extension:race.extension:detailed.value[x] | Base | required | Detailed Race | 📍6.1.0 | US Core v6.1 |
| Patient.extension:race.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.extension:ethnicity.extension:ombCategory.value[x] | Base | required | OMB Ethnicity Categories | 📍6.1.0 | US Core v6.1 |
| Patient.extension:ethnicity.extension:detailed.value[x] | Base | required | Detailed ethnicity | 📍6.1.0 | US Core v6.1 |
| Patient.extension:ethnicity.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.identifier.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍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.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍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.telecom:phone.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.gender.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.birthDate.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.address.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Patient.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1 |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.type | Base | required | AddressType | 📍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.communication.language.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| 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 | Patient.meta, Patient.implicitRules, Patient.language, Patient.text, Patient.extension, Patient.extension:race, Patient.extension:race.extension, Patient.extension:race.extension:ombCategory, Patient.extension:race.extension:ombCategory.extension, Patient.extension:race.extension:ombCategory.value[x], Patient.extension:race.extension:detailed, Patient.extension:race.extension:detailed.extension, Patient.extension:race.extension:detailed.value[x], Patient.extension:race.extension:text, Patient.extension:race.extension:text.extension, Patient.extension:race.extension:text.value[x], Patient.extension:race.extension:dataAbsentReason, Patient.extension:race.extension:dataAbsentReason.value[x], Patient.extension:ethnicity, Patient.extension:ethnicity.extension, Patient.extension:ethnicity.extension:ombCategory, Patient.extension:ethnicity.extension:ombCategory.extension, Patient.extension:ethnicity.extension:ombCategory.value[x], Patient.extension:ethnicity.extension:detailed, Patient.extension:ethnicity.extension:detailed.extension, Patient.extension:ethnicity.extension:detailed.value[x], Patient.extension:ethnicity.extension:text, Patient.extension:ethnicity.extension:text.extension, Patient.extension:ethnicity.extension:text.value[x], Patient.extension:ethnicity.extension:dataAbsentReason, Patient.extension:ethnicity.extension:dataAbsentReason.value[x], Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:birthPlace, Patient.modifierExtension, Patient.identifier, Patient.identifier.extension, Patient.identifier.extension:dataAbsentReason, Patient.identifier.extension:dataAbsentReason.value[x], Patient.identifier.use, Patient.identifier.type, Patient.identifier.system, Patient.identifier.value, Patient.identifier.period, Patient.identifier.assigner, Patient.active, Patient.name, Patient.name.extension, Patient.name.extension:dataAbsentReason, Patient.name.extension:dataAbsentReason.value[x], Patient.name.use, Patient.name.text, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.name.period, Patient.telecom, Patient.telecom.extension, Patient.telecom.extension:dataAbsentReason, Patient.telecom.extension:dataAbsentReason.value[x], Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom.rank, Patient.telecom.period, Patient.telecom:phone, Patient.telecom:phone.extension, Patient.telecom:phone.extension:dataAbsentReason, Patient.telecom:phone.extension:dataAbsentReason.value[x], Patient.telecom:phone.system, Patient.telecom:phone.value, Patient.telecom:phone.use, Patient.telecom:phone.rank, Patient.telecom:phone.period, Patient.telecom:email, Patient.telecom:email.extension, Patient.telecom:email.extension:dataAbsentReason, Patient.telecom:email.extension:dataAbsentReason.value[x], Patient.telecom:email.system, Patient.telecom:email.value, Patient.telecom:email.use, Patient.telecom:email.rank, Patient.telecom:email.period, Patient.gender, Patient.gender.extension, Patient.gender.extension:dataAbsentReason, Patient.gender.extension:dataAbsentReason.value[x], Patient.birthDate, Patient.birthDate.extension, Patient.birthDate.extension:dataAbsentReason, Patient.birthDate.extension:dataAbsentReason.value[x], Patient.deceased[x], Patient.address, Patient.address.extension, Patient.address.extension:dataAbsentReason, Patient.address.extension:dataAbsentReason.value[x], Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.period, Patient.maritalStatus, Patient.multipleBirth[x], Patient.photo, Patient.contact, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.name.extension, Patient.contact.name.extension:dataAbsentReason, Patient.contact.name.extension:dataAbsentReason.value[x], Patient.contact.name.use, Patient.contact.name.text, Patient.contact.name.family, Patient.contact.name.given, Patient.contact.name.prefix, Patient.contact.name.suffix, Patient.contact.name.period, Patient.contact.telecom, Patient.contact.telecom.extension, Patient.contact.telecom.extension:dataAbsentReason, Patient.contact.telecom.extension:dataAbsentReason.value[x], Patient.contact.telecom.system, Patient.contact.telecom.value, Patient.contact.telecom.use, Patient.contact.telecom.rank, Patient.contact.telecom.period, Patient.contact.address, Patient.contact.address.extension, Patient.contact.address.extension:dataAbsentReason, Patient.contact.address.extension:dataAbsentReason.value[x], Patient.contact.address.use, Patient.contact.address.type, Patient.contact.address.text, Patient.contact.address.line, Patient.contact.address.city, Patient.contact.address.district, Patient.contact.address.state, Patient.contact.address.postalCode, Patient.contact.address.country, Patient.contact.address.period, Patient.contact.gender, Patient.contact.organization, Patient.contact.period, Patient.communication, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.language.extension, Patient.communication.language.extension:dataAbsentReason, Patient.communication.language.extension:dataAbsentReason.value[x], Patient.communication.language.coding, Patient.communication.language.text, Patient.communication.preferred, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.other, Patient.link.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Patient.extension, Patient.extension:race, Patient.extension:race.extension, Patient.extension:race.extension:ombCategory, Patient.extension:race.extension:ombCategory.extension, Patient.extension:race.extension:detailed, Patient.extension:race.extension:detailed.extension, Patient.extension:race.extension:text, Patient.extension:race.extension:text.extension, Patient.extension:race.extension:dataAbsentReason, Patient.extension:ethnicity, Patient.extension:ethnicity.extension, Patient.extension:ethnicity.extension:ombCategory, Patient.extension:ethnicity.extension:ombCategory.extension, Patient.extension:ethnicity.extension:detailed, Patient.extension:ethnicity.extension:detailed.extension, Patient.extension:ethnicity.extension:text, Patient.extension:ethnicity.extension:text.extension, Patient.extension:ethnicity.extension:dataAbsentReason, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:birthPlace, Patient.modifierExtension, Patient.identifier.extension, Patient.identifier.extension:dataAbsentReason, Patient.name.extension, Patient.name.extension:dataAbsentReason, Patient.telecom.extension, Patient.telecom.extension:dataAbsentReason, Patient.telecom:phone.extension, Patient.telecom:phone.extension:dataAbsentReason, Patient.telecom:email.extension, Patient.telecom:email.extension:dataAbsentReason, Patient.gender.extension, Patient.gender.extension:dataAbsentReason, Patient.birthDate.extension, Patient.birthDate.extension:dataAbsentReason, Patient.address.extension, Patient.address.extension:dataAbsentReason, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.name.extension, Patient.contact.name.extension:dataAbsentReason, Patient.contact.telecom.extension, Patient.contact.telecom.extension:dataAbsentReason, Patient.contact.address.extension, Patient.contact.address.extension:dataAbsentReason, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language.extension, Patient.communication.language.extension:dataAbsentReason, Patient.link.extension, Patient.link.modifierExtension | 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()
|
Summary
Mandatory: 7 elements(4 nested mandatory elements)
Must-Support: 40 elements
Fixed: 14 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePatientProfile(6.1.0) | US Public Health Patient | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | (USCDI+) Race (US Core Race Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: ext-1 |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
S | 0..5 | Extension | (USCDI) American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ombCategory" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: OmbRaceCategories (6.1.0) (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997. | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extended race codes Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "detailed" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: DetailedRace (6.1.0) (required) | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | (USCDI) Race Text Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "text" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | (USCDI+) Ethnicity (US Core Ethnicity Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Constraints: ext-1 |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | (USCDI) Hispanic or Latino|Not Hispanic or Latino Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ombCategory" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: OmbEthnicityCategories (6.1.0) (required) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extended ethnicity codes Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "detailed" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: DetailedEthnicity (6.1.0) (required) | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | (USCDI) ethnicity Text Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "text" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity" | |
![]() ![]() ![]() |
S | 0..* | (Complex) | (USCDI+) Tribal Affiliation, (USCDI+) Tribal Enrollment (US Core Tribal Affiliation Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation Constraints: ext-1 |
![]() ![]() ![]() |
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 Constraints: ext-1 | |
![]() ![]() ![]() |
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.Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | CodeableConcept | (USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)Constraints: ext-1 | |
![]() ![]() ![]() |
S | 0..1 | Address | (USCDI+) Patient Birth Place (FHIR Patient Birth Place Extension) URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace Constraints: ext-1 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣ | 1..* | Identifier | (USCDI+) Patient Identifier, (USCDI+) Medical Record Number, (USCDI+) Medicare Patient Identifier |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() |
SΣC | 1..* | HumanName | (USCDI+) Patient Name Constraints: us-core-6 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() |
SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') |
![]() ![]() ![]() |
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 |
![]() ![]() |
SΣ | 1..* | ContactPoint | (USCDI) A contact detail for the individual Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | (USCDI+) Phone Number |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | (USCDI+) Email Address |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() |
SΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() |
SΣ | 1..1 | date | (USCDI+) Date of Birth |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() |
?!SΣ | 1..1 | If patient is deceased, use type dateTime and set to deceased date. | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
SΣ | 1..* | Address | (USCDI+) Current Address |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 0..1 | string | County Example General: Madison |
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes. |
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 |
![]() ![]() |
SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Relationship Type, Parent/Guardian Code Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. |
![]() ![]() ![]() |
S | 1..1 | HumanName | (USCDI+) Parent/Guardian Name |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() |
S | 1..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() |
S | 1..1 | Address | Parent/Guardian Address |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() |
S | 1..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Preferred Language Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked |
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() |
Σ | 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.extension:race.extension:ombCategory.value[x] | Base | required | OMB Race Categories | 📍6.1.0 | US Core v6.1 |
| Patient.extension:race.extension:detailed.value[x] | Base | required | Detailed Race | 📍6.1.0 | US Core v6.1 |
| Patient.extension:race.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.extension:ethnicity.extension:ombCategory.value[x] | Base | required | OMB Ethnicity Categories | 📍6.1.0 | US Core v6.1 |
| Patient.extension:ethnicity.extension:detailed.value[x] | Base | required | Detailed ethnicity | 📍6.1.0 | US Core v6.1 |
| Patient.extension:ethnicity.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.identifier.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.name.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍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.telecom:phone.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.gender.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.birthDate.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.address.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1 |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.use | Base | required | AddressUse | 📍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.communication.language.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| 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 | Patient.implicitRules, Patient.extension, Patient.extension:race, Patient.extension:race.extension, Patient.extension:race.extension:ombCategory, Patient.extension:race.extension:ombCategory.value[x], Patient.extension:race.extension:detailed, Patient.extension:race.extension:detailed.value[x], Patient.extension:race.extension:text, Patient.extension:race.extension:text.value[x], Patient.extension:race.extension:dataAbsentReason, Patient.extension:race.extension:dataAbsentReason.value[x], Patient.extension:ethnicity, Patient.extension:ethnicity.extension, Patient.extension:ethnicity.extension:ombCategory, Patient.extension:ethnicity.extension:ombCategory.value[x], Patient.extension:ethnicity.extension:detailed, Patient.extension:ethnicity.extension:detailed.value[x], Patient.extension:ethnicity.extension:text, Patient.extension:ethnicity.extension:text.value[x], Patient.extension:ethnicity.extension:dataAbsentReason, Patient.extension:ethnicity.extension:dataAbsentReason.value[x], Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:birthPlace, Patient.modifierExtension, Patient.identifier, Patient.identifier.extension:dataAbsentReason, Patient.identifier.extension:dataAbsentReason.value[x], Patient.identifier.use, Patient.identifier.system, Patient.identifier.value, Patient.active, Patient.name, Patient.name.extension:dataAbsentReason, Patient.name.extension:dataAbsentReason.value[x], Patient.name.use, Patient.name.family, Patient.name.given, Patient.telecom, Patient.telecom.extension:dataAbsentReason, Patient.telecom.extension:dataAbsentReason.value[x], Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom:phone, Patient.telecom:phone.extension:dataAbsentReason, Patient.telecom:phone.extension:dataAbsentReason.value[x], Patient.telecom:phone.system, Patient.telecom:phone.value, Patient.telecom:phone.use, Patient.telecom:email, Patient.telecom:email.extension:dataAbsentReason, Patient.telecom:email.extension:dataAbsentReason.value[x], Patient.telecom:email.system, Patient.telecom:email.value, Patient.telecom:email.use, Patient.gender, Patient.gender.extension, Patient.gender.extension:dataAbsentReason, Patient.gender.extension:dataAbsentReason.value[x], Patient.birthDate, Patient.birthDate.extension, Patient.birthDate.extension:dataAbsentReason, Patient.birthDate.extension:dataAbsentReason.value[x], Patient.deceased[x], Patient.address, Patient.address.extension:dataAbsentReason, Patient.address.extension:dataAbsentReason.value[x], Patient.address.use, Patient.address.line, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.contact, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.name.extension:dataAbsentReason, Patient.contact.name.extension:dataAbsentReason.value[x], Patient.contact.name.use, Patient.contact.telecom, Patient.contact.telecom.extension:dataAbsentReason, Patient.contact.telecom.extension:dataAbsentReason.value[x], Patient.contact.telecom.use, Patient.contact.address, Patient.contact.address.extension:dataAbsentReason, Patient.contact.address.extension:dataAbsentReason.value[x], Patient.contact.address.use, Patient.communication, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.language.extension:dataAbsentReason, Patient.communication.language.extension:dataAbsentReason.value[x], Patient.link, Patient.link.modifierExtension, Patient.link.other, Patient.link.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Patient.extension, Patient.extension:race, Patient.extension:race.extension, Patient.extension:race.extension:ombCategory, Patient.extension:race.extension:detailed, Patient.extension:race.extension:text, Patient.extension:race.extension:dataAbsentReason, Patient.extension:ethnicity, Patient.extension:ethnicity.extension, Patient.extension:ethnicity.extension:ombCategory, Patient.extension:ethnicity.extension:detailed, Patient.extension:ethnicity.extension:text, Patient.extension:ethnicity.extension:dataAbsentReason, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:birthPlace, Patient.modifierExtension, Patient.identifier.extension:dataAbsentReason, Patient.name.extension:dataAbsentReason, Patient.telecom.extension:dataAbsentReason, Patient.telecom:phone.extension:dataAbsentReason, Patient.telecom:email.extension:dataAbsentReason, Patient.gender.extension, Patient.gender.extension:dataAbsentReason, Patient.birthDate.extension, Patient.birthDate.extension:dataAbsentReason, Patient.address.extension:dataAbsentReason, Patient.contact.modifierExtension, Patient.contact.name.extension:dataAbsentReason, Patient.contact.telecom.extension:dataAbsentReason, Patient.contact.address.extension:dataAbsentReason, Patient.communication.modifierExtension, Patient.communication.language.extension:dataAbsentReason, Patient.link.modifierExtension | 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()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePatientProfile(6.1.0) | US Public Health Patient | |
![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | USCoreRaceExtension(6.1.0) | (USCDI+) Race (US Core Race Extension) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 1..1 | USCoreEthnicityExtension(6.1.0) | (USCDI+) Ethnicity (US Core Ethnicity Extension) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 0..* | USCoreTribalAffiliationExtension(6.1.0) | (USCDI+) Tribal Affiliation, (USCDI+) Tribal Enrollment (US Core Tribal Affiliation Extension) |
![]() ![]() ![]() |
S | 0..1 | Address | (USCDI+) Patient Birth Place (FHIR Patient Birth Place Extension) URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
![]() ![]() |
1..* | Identifier | (USCDI+) Patient Identifier, (USCDI+) Medical Record Number, (USCDI+) Medicare Patient Identifier | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
1..* | HumanName | (USCDI+) Patient Name | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
S | 1..* | ContactPoint | (USCDI) A contact detail for the individual Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 0..* | ContactPoint | (USCDI+) Phone Number |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
![]() ![]() ![]() ![]() |
1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Fixed Value: phone | |
![]() ![]() ![]() |
S | 0..* | ContactPoint | (USCDI+) Email Address |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
![]() ![]() ![]() ![]() |
1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Fixed Value: email | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
1..1 | date | (USCDI+) Date of Birth | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
S | 1..1 | boolean, dateTime | If patient is deceased, use type dateTime and set to deceased date. |
![]() ![]() |
1..* | Address | (USCDI+) Current Address | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 0..1 | string | County |
![]() ![]() |
S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Relationship Type, Parent/Guardian Code |
![]() ![]() ![]() |
S | 1..1 | HumanName | (USCDI+) Parent/Guardian Name |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 1..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() ![]() |
S | 1..1 | Address | Parent/Guardian Address |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
![]() ![]() |
S | 1..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() |
1..1 | CodeableConcept | (USCDI+) Preferred Language | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Fixed Value: masked |
Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCorePatientProfile(6.1.0) | US Public Health Patient | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | (USCDI+) Race (US Core Race Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..5 | Extension | (USCDI) American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ombCategory" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: OmbRaceCategories (6.1.0) (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extended race codes Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "detailed" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: DetailedRace (6.1.0) (required) | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | (USCDI) Race Text Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "text" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" | |||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | (USCDI+) Ethnicity (US Core Ethnicity Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Extension | (USCDI) Hispanic or Latino|Not Hispanic or Latino Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "ombCategory" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: OmbEthnicityCategories (6.1.0) (required) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extended ethnicity codes Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "detailed" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: DetailedEthnicity (6.1.0) (required) | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | (USCDI) ethnicity Text Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "text" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | For masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity" | |||||
![]() ![]() ![]() |
S | 0..* | (Complex) | (USCDI+) Tribal Affiliation, (USCDI+) Tribal Enrollment (US Core Tribal Affiliation Extension) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation Constraints: ext-1 | ||||
![]() ![]() ![]() |
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 Constraints: ext-1 | |||||
![]() ![]() ![]() |
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.Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | (USCDI) The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)Constraints: ext-1 | |||||
![]() ![]() ![]() |
S | 0..1 | Address | (USCDI+) Patient Birth Place (FHIR Patient Birth Place Extension) URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace Constraints: ext-1 | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣ | 1..* | Identifier | (USCDI+) Patient Identifier, (USCDI+) Medical Record Number, (USCDI+) Medicare Patient Identifier | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() |
SΣC | 1..* | HumanName | (USCDI+) Patient Name Constraints: us-core-6 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | (USCDI) Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | (USCDI) Time period when name was/is in use | ||||
![]() ![]() |
SΣ | 1..* | ContactPoint | (USCDI) A contact detail for the individual Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | (USCDI+) Phone Number | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | (USCDI+) Email Address | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required) | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() |
SΣ | 1..1 | date | (USCDI+) Date of Birth | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||
![]() ![]() |
?!SΣ | 1..1 | If patient is deceased, use type dateTime and set to deceased date. | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
SΣ | 1..* | Address | (USCDI+) Current Address | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | County Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Relationship Type, Parent/Guardian Code Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | ||||
![]() ![]() ![]() |
S | 1..1 | HumanName | (USCDI+) Parent/Guardian Name | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
S | 1..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 1..1 | Address | Parent/Guardian Address | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
S | 1..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI+) Preferred Language Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() |
Σ | 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.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.extension:race.extension:ombCategory.value[x] | Base | required | OMB Race Categories | 📍6.1.0 | US Core v6.1 |
| Patient.extension:race.extension:detailed.value[x] | Base | required | Detailed Race | 📍6.1.0 | US Core v6.1 |
| Patient.extension:race.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.extension:ethnicity.extension:ombCategory.value[x] | Base | required | OMB Ethnicity Categories | 📍6.1.0 | US Core v6.1 |
| Patient.extension:ethnicity.extension:detailed.value[x] | Base | required | Detailed ethnicity | 📍6.1.0 | US Core v6.1 |
| Patient.extension:ethnicity.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.identifier.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍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.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍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.telecom:phone.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.gender.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.birthDate.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.address.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Patient.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1 |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Patient.contact.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.address.type | Base | required | AddressType | 📍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.communication.language.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| 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 | Patient.meta, Patient.implicitRules, Patient.language, Patient.text, Patient.extension, Patient.extension:race, Patient.extension:race.extension, Patient.extension:race.extension:ombCategory, Patient.extension:race.extension:ombCategory.extension, Patient.extension:race.extension:ombCategory.value[x], Patient.extension:race.extension:detailed, Patient.extension:race.extension:detailed.extension, Patient.extension:race.extension:detailed.value[x], Patient.extension:race.extension:text, Patient.extension:race.extension:text.extension, Patient.extension:race.extension:text.value[x], Patient.extension:race.extension:dataAbsentReason, Patient.extension:race.extension:dataAbsentReason.value[x], Patient.extension:ethnicity, Patient.extension:ethnicity.extension, Patient.extension:ethnicity.extension:ombCategory, Patient.extension:ethnicity.extension:ombCategory.extension, Patient.extension:ethnicity.extension:ombCategory.value[x], Patient.extension:ethnicity.extension:detailed, Patient.extension:ethnicity.extension:detailed.extension, Patient.extension:ethnicity.extension:detailed.value[x], Patient.extension:ethnicity.extension:text, Patient.extension:ethnicity.extension:text.extension, Patient.extension:ethnicity.extension:text.value[x], Patient.extension:ethnicity.extension:dataAbsentReason, Patient.extension:ethnicity.extension:dataAbsentReason.value[x], Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:birthPlace, Patient.modifierExtension, Patient.identifier, Patient.identifier.extension, Patient.identifier.extension:dataAbsentReason, Patient.identifier.extension:dataAbsentReason.value[x], Patient.identifier.use, Patient.identifier.type, Patient.identifier.system, Patient.identifier.value, Patient.identifier.period, Patient.identifier.assigner, Patient.active, Patient.name, Patient.name.extension, Patient.name.extension:dataAbsentReason, Patient.name.extension:dataAbsentReason.value[x], Patient.name.use, Patient.name.text, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.name.period, Patient.telecom, Patient.telecom.extension, Patient.telecom.extension:dataAbsentReason, Patient.telecom.extension:dataAbsentReason.value[x], Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom.rank, Patient.telecom.period, Patient.telecom:phone, Patient.telecom:phone.extension, Patient.telecom:phone.extension:dataAbsentReason, Patient.telecom:phone.extension:dataAbsentReason.value[x], Patient.telecom:phone.system, Patient.telecom:phone.value, Patient.telecom:phone.use, Patient.telecom:phone.rank, Patient.telecom:phone.period, Patient.telecom:email, Patient.telecom:email.extension, Patient.telecom:email.extension:dataAbsentReason, Patient.telecom:email.extension:dataAbsentReason.value[x], Patient.telecom:email.system, Patient.telecom:email.value, Patient.telecom:email.use, Patient.telecom:email.rank, Patient.telecom:email.period, Patient.gender, Patient.gender.extension, Patient.gender.extension:dataAbsentReason, Patient.gender.extension:dataAbsentReason.value[x], Patient.birthDate, Patient.birthDate.extension, Patient.birthDate.extension:dataAbsentReason, Patient.birthDate.extension:dataAbsentReason.value[x], Patient.deceased[x], Patient.address, Patient.address.extension, Patient.address.extension:dataAbsentReason, Patient.address.extension:dataAbsentReason.value[x], Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.period, Patient.maritalStatus, Patient.multipleBirth[x], Patient.photo, Patient.contact, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.name.extension, Patient.contact.name.extension:dataAbsentReason, Patient.contact.name.extension:dataAbsentReason.value[x], Patient.contact.name.use, Patient.contact.name.text, Patient.contact.name.family, Patient.contact.name.given, Patient.contact.name.prefix, Patient.contact.name.suffix, Patient.contact.name.period, Patient.contact.telecom, Patient.contact.telecom.extension, Patient.contact.telecom.extension:dataAbsentReason, Patient.contact.telecom.extension:dataAbsentReason.value[x], Patient.contact.telecom.system, Patient.contact.telecom.value, Patient.contact.telecom.use, Patient.contact.telecom.rank, Patient.contact.telecom.period, Patient.contact.address, Patient.contact.address.extension, Patient.contact.address.extension:dataAbsentReason, Patient.contact.address.extension:dataAbsentReason.value[x], Patient.contact.address.use, Patient.contact.address.type, Patient.contact.address.text, Patient.contact.address.line, Patient.contact.address.city, Patient.contact.address.district, Patient.contact.address.state, Patient.contact.address.postalCode, Patient.contact.address.country, Patient.contact.address.period, Patient.contact.gender, Patient.contact.organization, Patient.contact.period, Patient.communication, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.language.extension, Patient.communication.language.extension:dataAbsentReason, Patient.communication.language.extension:dataAbsentReason.value[x], Patient.communication.language.coding, Patient.communication.language.text, Patient.communication.preferred, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.other, Patient.link.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Patient.extension, Patient.extension:race, Patient.extension:race.extension, Patient.extension:race.extension:ombCategory, Patient.extension:race.extension:ombCategory.extension, Patient.extension:race.extension:detailed, Patient.extension:race.extension:detailed.extension, Patient.extension:race.extension:text, Patient.extension:race.extension:text.extension, Patient.extension:race.extension:dataAbsentReason, Patient.extension:ethnicity, Patient.extension:ethnicity.extension, Patient.extension:ethnicity.extension:ombCategory, Patient.extension:ethnicity.extension:ombCategory.extension, Patient.extension:ethnicity.extension:detailed, Patient.extension:ethnicity.extension:detailed.extension, Patient.extension:ethnicity.extension:text, Patient.extension:ethnicity.extension:text.extension, Patient.extension:ethnicity.extension:dataAbsentReason, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:birthPlace, Patient.modifierExtension, Patient.identifier.extension, Patient.identifier.extension:dataAbsentReason, Patient.name.extension, Patient.name.extension:dataAbsentReason, Patient.telecom.extension, Patient.telecom.extension:dataAbsentReason, Patient.telecom:phone.extension, Patient.telecom:phone.extension:dataAbsentReason, Patient.telecom:email.extension, Patient.telecom:email.extension:dataAbsentReason, Patient.gender.extension, Patient.gender.extension:dataAbsentReason, Patient.birthDate.extension, Patient.birthDate.extension:dataAbsentReason, Patient.address.extension, Patient.address.extension:dataAbsentReason, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.name.extension, Patient.contact.name.extension:dataAbsentReason, Patient.contact.telecom.extension, Patient.contact.telecom.extension:dataAbsentReason, Patient.contact.address.extension, Patient.contact.address.extension:dataAbsentReason, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language.extension, Patient.communication.language.extension:dataAbsentReason, Patient.link.extension, Patient.link.modifierExtension | 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()
|
Summary
Mandatory: 7 elements(4 nested mandatory elements)
Must-Support: 40 elements
Fixed: 14 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron