Vital Records Common Library (VRCL) FHIR Implementation Guide, 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/vr-common-library/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-vr | Version: 2.0.0 | |||
Active as of 2024-09-16 | Computable Name: PatientVitalRecords |
This abstract Patient profile includes common extensions and slicing used across vital records.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePatientProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | USCorePatientProfile | This is an abstractprofile. Childprofiles: PatientChildVitalRecords, PatientMotherVitalRecords | ||
Slices for extension | Content/Rules for all slices | |||
birthPlace | 0..1 | (Complex) | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
value[x] | ||||
city | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cityCode | 0..1 | positiveInt | City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
district | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |
state | 0..1 | string | State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
nationalReportingJurisdictionId | 0..1 | string | Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required) | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required) | |
parentReportedAgeAtDelivery | 0..2 | (Complex) | Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |
Slices for identifier | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | |
identifier:MRN | 0..* | Identifier | Medical Record Number | |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
identifier:SSN | 0..1 | Identifier | SSN if available and appropriate to send | |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn | |
Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | |
name:All Slices | Content/Rules for all slices | |||
family | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
given | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
name:currentLegalName | 0..1 | HumanName | current legal name | |
use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
name:namePriorToFirstMarriage | 0..1 | HumanName | Name prior to first marriage | |
use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |
birthDate | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
partialDateTime | 0..1 | (Complex) | partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr | |
birthTime | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
bypassEditFlag | 0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
value[x] | 1..1 | CodeableConcept | To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
Slices for deceased[x] | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
deceased[x]:deceasedBoolean | C | 0..1 | boolean | Boolean indicator. True if the individual is deceased. fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
fetalDeath | 0..1 | boolean | Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr | |
address | ||||
Slices for extension | Content/Rules for all slices | |||
withinCityLimitsIndicator | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |
predir | 0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
stnum | 0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
stname | 0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
stdesig | 0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
postdir | 0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
unitnumber | 0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
city | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cityCode | 0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
district | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |
state | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required) | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required) | |
multipleBirth[x] | 0..1 | boolean, integer | If not single birth - born first, second, third, etc. | |
Slices for extension | Content/Rules for all slices | |||
bypassEditFlag | 0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |
multipleBirthTotal | 0..1 | positiveInt | Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.extension:birthPlace.value[x].state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG | |
Patient.extension:birthPlace.value[x].country | required | ValueSetBirthplaceCountryVitalRecords (a valid code from Code System - Country Codes Vital Records)http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr from this IG | |
Patient.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetDateOfBirthEditFlagsVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr from this IG | |
Patient.address.state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG | |
Patient.address.country | required | ValueSetResidenceCountryVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG | |
Patient.multipleBirth[x].extension:bypassEditFlag.value[x] | required | ValueSetPluralityEditFlagsVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr from this IG |
Id | Grade | Path(s) | Details | Requirements |
fetalDeathOnlyIfDeceased | error | Patient.deceased[x]:deceasedBoolean | Fetal death should only be indicated if Patient is deceased. : (extension.where(url = 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr').exists(value.exists() and value = 'true')) implies (value.exists() and value = 'true') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | USCorePatientProfile | This is an abstractprofile. Childprofiles: PatientChildVitalRecords, PatientMotherVitalRecords Information about an individual or animal receiving health care services us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
race | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
ethnicity | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
birthsex | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
genderIdentity | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |
birthPlace | 0..1 | (Complex) | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
value[x] | 1..1 | Address | Value of extension | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
state | Σ | 0..1 | string | State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
nationalReportingJurisdictionId | 0..1 | string | Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required) | |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required) |
parentReportedAgeAtDelivery | 0..2 | (Complex) | Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type |
identifier:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:MRN | SΣ | 0..* | Identifier | Medical Record Number |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:SSN | SΣ | 0..1 | Identifier | SSN if available and appropriate to send |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |
system | SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
name:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣC | 0..1 | string | Family name (often called 'Surname') |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
name:currentLegalName | SΣ | 0..1 | HumanName | current legal name |
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
family | SΣC | 0..1 | string | Family name (often called 'Surname') |
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
name:namePriorToFirstMarriage | SΣ | 0..1 | HumanName | Name prior to first marriage |
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden |
family | SΣC | 0..1 | string | Family name (often called 'Surname') |
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | SΣ | 0..1 | date | The date of birth for the individual |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
partialDateTime | 0..1 | (Complex) | partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr | |
birthTime | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
bypassEditFlag | 0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
value[x] | 1..1 | CodeableConcept | To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
deceased[x]:deceasedBoolean | ?!ΣC | 0..1 | boolean | Boolean indicator. True if the individual is deceased. fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
fetalDeath | 0..1 | boolean | Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr | |
address | SΣ | 0..* | Address | An address for the individual |
Slices for extension | Content/Rules for all slices | |||
withinCityLimitsIndicator | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |
predir | 0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
stnum | 0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
stname | 0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
stdesig | 0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
postdir | 0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
unitnumber | 0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cityCode | 0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required) |
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required) |
period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
multipleBirth[x] | 0..1 | If not single birth - born first, second, third, etc. | ||
multipleBirth[x]All Types | Content/Rules for all Types | |||
Slices for extension | Content/Rules for all slices | |||
bypassEditFlag | 0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |
multipleBirthTotal | 0..1 | positiveInt | Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal | |
multipleBirthBoolean | boolean | |||
multipleBirthInteger | integer | |||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Patient.extension:birthPlace.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.extension:birthPlace.value[x].state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG | |
Patient.extension:birthPlace.value[x].country | required | ValueSetBirthplaceCountryVitalRecords (a valid code from Code System - Country Codes Vital Records)http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr from this IG | |
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:MRN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:MRN.type | extensible | Pattern: MRhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.identifier:SSN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:SSN.type | extensible | Pattern: SShttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.name:currentLegalName.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.name:namePriorToFirstMarriage.use | required | Fixed Value: maidenhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard | |
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard | |
Patient.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetDateOfBirthEditFlagsVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr from this IG | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.address.state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG | |
Patient.address.country | required | ValueSetResidenceCountryVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG | |
Patient.multipleBirth[x].extension:bypassEditFlag.value[x] | required | ValueSetPluralityEditFlagsVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr from this IG | |
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifierhttp://hl7.org/fhir/us/core/ValueSet/simple-language | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
fetalDeathOnlyIfDeceased | error | Patient.deceased[x]:deceasedBoolean | Fetal death should only be indicated if Patient is deceased. : (extension.where(url = 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr').exists(value.exists() and value = 'true')) implies (value.exists() and value = 'true') |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | USCorePatientProfile | This is an abstractprofile. Childprofiles: PatientChildVitalRecords, PatientMotherVitalRecords Information about an individual or animal receiving health care services us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
race | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
ethnicity | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
birthsex | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |||||
genderIdentity | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |||||
birthPlace | 0..1 | (Complex) | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
value[x] | 1..1 | Address | Value of extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 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 | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
cityCode | 0..1 | positiveInt | City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
state | Σ | 0..1 | string | State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
nationalReportingJurisdictionId | 0..1 | string | Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required) | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
parentReportedAgeAtDelivery | 0..2 | (Complex) | Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:MRN | SΣ | 0..* | Identifier | Medical Record Number | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:SSN | SΣ | 0..1 | Identifier | SSN if available and appropriate to send | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
name:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣC | 0..1 | string | Family name (often called 'Surname') | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:currentLegalName | SΣ | 0..1 | HumanName | current legal name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣC | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:namePriorToFirstMarriage | SΣ | 0..1 | HumanName | Name prior to first marriage | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣC | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
birthDate | SΣ | 0..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
partialDateTime | 0..1 | (Complex) | partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr | |||||
birthTime | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |||||
bypassEditFlag | 0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
value[x] | 1..1 | CodeableConcept | To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |||||
value | 0..1 | date | Primitive value for date | |||||
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
deceased[x]:deceasedBoolean | ?!ΣC | 0..1 | boolean | Boolean indicator. True if the individual is deceased. fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
fetalDeath | 0..1 | boolean | Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr | |||||
value | 0..1 | boolean | Primitive value for boolean | |||||
address | SΣ | 0..* | Address | An address for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
withinCityLimitsIndicator | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |||||
predir | 0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |||||
stnum | 0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |||||
stname | 0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |||||
stdesig | 0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |||||
postdir | 0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |||||
unitnumber | 0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
cityCode | 0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required) | ||||
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required) | ||||
period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
multipleBirth[x] | 0..1 | If not single birth - born first, second, third, etc. | ||||||
multipleBirth[x]All Types | Content/Rules for all Types | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
bypassEditFlag | 0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |||||
multipleBirthTotal | 0..1 | positiveInt | Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal | |||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | ||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.extension:birthPlace.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.extension:birthPlace.value[x].type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.extension:birthPlace.value[x].state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG | ||||
Patient.extension:birthPlace.value[x].country | required | ValueSetBirthplaceCountryVitalRecords (a valid code from Code System - Country Codes Vital Records)http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr from this IG | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:MRN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:MRN.type | extensible | Pattern: MRhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:SSN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:SSN.type | extensible | Pattern: SShttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:currentLegalName.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:namePriorToFirstMarriage.use | required | Fixed Value: maidenhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard | ||||
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard | ||||
Patient.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetDateOfBirthEditFlagsVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr from this IG | ||||
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.address.state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG | ||||
Patient.address.country | required | ValueSetResidenceCountryVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.multipleBirth[x].extension:bypassEditFlag.value[x] | required | ValueSetPluralityEditFlagsVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr from this IG | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifierhttp://hl7.org/fhir/us/core/ValueSet/simple-language | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
fetalDeathOnlyIfDeceased | error | Patient.deceased[x]:deceasedBoolean | Fetal death should only be indicated if Patient is deceased. : (extension.where(url = 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr').exists(value.exists() and value = 'true')) implies (value.exists() and value = 'true') |
This structure is derived from USCorePatientProfile
Summary
Mandatory: 0 element(4 nested mandatory elements)
Fixed: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCorePatientProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | USCorePatientProfile | This is an abstractprofile. Childprofiles: PatientChildVitalRecords, PatientMotherVitalRecords | ||
Slices for extension | Content/Rules for all slices | |||
birthPlace | 0..1 | (Complex) | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
value[x] | ||||
city | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cityCode | 0..1 | positiveInt | City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
district | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |
state | 0..1 | string | State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
nationalReportingJurisdictionId | 0..1 | string | Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required) | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required) | |
parentReportedAgeAtDelivery | 0..2 | (Complex) | Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |
Slices for identifier | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | |
identifier:MRN | 0..* | Identifier | Medical Record Number | |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
identifier:SSN | 0..1 | Identifier | SSN if available and appropriate to send | |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn | |
Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | |
name:All Slices | Content/Rules for all slices | |||
family | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url |