Vital Records Common Library (VRCL) STU2-ballot, 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-child-vr | Version: 2.0.0 | |||
Active as of 2024-05-20 | Computable Name: PatientChildVitalRecords |
The subject patient (newborn/infant/child) for whom clinical data is included in the report.
This profile adds further constraints to the US Core Patient such as:
the patient-birthPlace extension
the patient-birthTime extension
the patient-multipleBirthTotal extension to record plurality
the base FHIR data-absent-reason extension to both name.given and name.family (a name may not yet have been chosen for the baby and US Core Patient requires that Patient.name.given or Patient.name.family or both SHALL be present)
Profile conformance requires that gender be provided, see note on patient gender.
Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
---|---|---|---|---|---|---|
Natality | 1 | Date of Birth (Infant)--Year | IDOB_YR | birthDate | date | See note on birth date and time |
Natality | 2 | State, U.S. Territory or Canadian Province of Birth (Infant) - code | BSTATE | extension[birthPlace].value[x].state | string | ValueSetJurisdictionVitalRecords |
Natality | 6 | Time of Birth | TB | birthDate.extension[patient-birthTime] | dateTime | See note on birth date and time |
Natality | 7 | Sex | ISEX | extension[birthsex].value | codeable | ValueSetSexAssignedAtBirthVitalRecords |
Natality | 8 | Date of Birth (Infant)--Month | IDOB_MO | birthDate | date | See note on birth date and time |
Natality | 9 | Date of Birth (Infant)--Day | IDOB_DY | birthDate | date | See note on birth date and time |
Natality | 10 | County of Birth | CNTYO | extension[birthPlace].value[x].district.extension[districtCode] | integer | See CountyCodes |
Natality | 207 | Plurality | PLUR | extension[patient-multipleBirthTotal].valuePositiveInt | integer | |
Natality | 208 | Set Order | SORD | multipleBirth[x] | integer | |
Natality | 211 | Plurality--Edit Flag | PLUR_BYPASS | multipleBirth.extension[bypassEditFlag].value | codeable | ValueSetPluralityEditFlagsVitalRecords, See Handling of edit flags |
Natality | 237 | Mother's Reported Age | MAGER | extension[parentReportedAgeAtDelivery].extension[reportedAge].value, extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='MTH' |
quantity | |
Natality | 238 | Father's Reported Age | FAGER | extension[parentReportedAgeAtDelivery].extension[reportedAge].value, extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='FTH' |
quantity | |
Natality | 247 | Child's First Name | KIDFNAME | name.given, name.use = official |
string | See note on Child and Decedent Fetus name |
Natality | 248 | Child's Middle Name | KIDMNAME | name.given, name.use = official |
string | See note on Child and Decedent Fetus name |
Natality | 249 | Child's Last Name | KIDLNAME | name.family, name.use = official |
string | See note on Child and Decedent Fetus name |
Natality | 250 | Child's Surname Suffix (moved from end) | KIDSUFFX | name.suffix, name.use = official |
string | |
Natality | 251 | County of Birth (Literal) | BIRTH_CO | extension[patient-birthPlace].value[x].district | string | |
Natality | 252 | City/town/place of birth (Literal) | BRTHCITY | extension[patient-birthPlace].value[x].city | string | |
Natality | 332 | Infant's Medical Record Number | INF_MED_REC_NUM | identifier.value where system = ‘http://terminology.hl7.org/CodeSystem/v2-0203' and type.coding.code=”MR” |
string |
Item # | Form Field | FHIR Profile Field | Reference |
---|---|---|---|
1 | Child’s Name | name | Certificate of Live Birth |
2 | Child's Time of Birth | extension:birthTime | Certificate of Live Birth |
3 | Child's Sex | extension:birthsex | Certificate of Live Birth |
4 | Child's Date Of Birth | birthDate | Certificate of Live Birth |
6 | City, Town, Or Location Of Birth | extension:birthPlace | Certificate of Live Birth |
7 | County Of Birth | extension:birthPlace | Certificate of Live Birth |
24 | Father of Hispanic Origin? | extension:ethnicity | Certificate of Live Birth |
25 | Father’s Race | extension:race | Certificate of Live Birth |
48 | Newborn Medical Record Number | identifier:MRN | Certificate of Live Birth |
52 | Plurality | multipleBirth[x].extension:multipleBirthTotal | Certificate of Live Birth |
53 | If Not Single Birth - Born First, Second, Third, etc. (Specify) | multipleBirthInteger | Certificate of Live Birth |
3 | City, Town or Location of birth | extension:birthPlace | Facility Worksheet for the Live Birth Certificate |
4 | County of birth | extension:birthPlace | Facility Worksheet for the Live Birth Certificate |
17 | Date of birth | birthDate | Facility Worksheet for the Live Birth Certificate |
18 | Time of birth | birthDate.extension:birthTime | Facility Worksheet for the Live Birth Certificate |
22 | Infant’s medical record number | identifier:MRN | Facility Worksheet for the Live Birth Certificate |
31 | Sex: | extension:birthsex | Facility Worksheet for the Live Birth Certificate |
33 | Plurality | multipleBirthInteger.extension:multipleBirthTotal | Facility Worksheet for the Live Birth Certificate |
34 | If not single birth, order delivered in the pregnancy | multipleBirthInteger | Facility Worksheet for the Live Birth Certificate |
- | Child’s name/medical record # | identifier | Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births |
17 | Date of birth | birthDate | Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births |
18 | Time of birth | birthDate.extension:birthTime | Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births |
34 | Order delivered in the pregnancy | multipleBirthInteger | Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births |
31 | Sex | extension:birthsex | Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births |
2 | What will be your baby’s legal name? | name | Mothers Worksheet for Child’s Birth Certificate |
33 | Plurality | multipleBirthInteger.extension:multipleBirthTotal | Report of Fetal Death |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PatientVitalRecords
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PatientVitalRecords | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | USCoreRaceExtension | US Core Race Extension |
![]() ![]() ![]() ![]() |
S | 0..1 | USCoreEthnicityExtension | US Core ethnicity Extension |
![]() ![]() ![]() ![]() |
S | 1..1 | USCoreBirthSexExtension | Extension |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Sex Binding: Sex Assigned At Birth Vital Records (required) | |
![]() ![]() ![]() ![]() |
S | 0..1 | PatBirthPlace(5.1.0) | Place of Birth for patient |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | ExtensionDistrictCodeVitalRecords | County of birth | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | State of Birth | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | ExtensionLocationJurisdictionIdVitalRecords | Jurisdiction of Birth | |
![]() ![]() ![]() ![]() |
0..2 | ExtensionReportedParentAgeAtDeliveryVitalRecords | The mother or father's reported age at the time of delivery of the child | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Reported age | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | Identifier | Medical Record Number |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Identifier type code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Medical record number | |
![]() ![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() ![]() |
0..1 | code | The use of a human name | |
![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | DataAbsentReason(5.1.0) | When "name not chosen" use code "temp-unknown" | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | DataAbsentReason(5.1.0) | When "name not chosen" use code "temp-unknown" | |
![]() ![]() ![]() ![]() |
0..* | string | Surname suffix | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | HumanName | current legal name | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() |
0..1 | HumanName | Name prior to first marriage | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() |
1..1 | date | Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time]. | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | ExtensionPartialDateTimeVitalRecords | Use if only partial date and time of birth is known |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | PatBirthTime(5.1.0) | Time of Birth |
![]() ![]() ![]() |
S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not, dateTime is preferred |
![]() ![]() ![]() |
S | 0..1 | integer | If not single birth - born first, second, third, etc. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | ExtensionBypassEditFlagVitalRecords | BypassEditFlag Vital Records | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | PatMultipleBirthTotal | Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |
![]() |
Path | Conformance | ValueSet | URI |
Patient.extension:birthsex.value[x] | required | ValueSetSexAssignedAtBirthVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | PatientVitalRecords | 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. |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Sex Binding: Sex Assigned At Birth Vital Records (required) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Address | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 | string | State of Birth Binding: States, Territories and Provinces Vital Records (required) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Jurisdiction of Birth URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Jurisdictions Vital Records (required) | |
![]() ![]() ![]() ![]() |
0..2 | (Complex) | The mother or father's reported age at the time of delivery of the child URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |
![]() ![]() ![]() ![]() ![]() |
2..3 | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reportedAge" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Reported age | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "motherOrFather" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code Binding: Role Vital Records (extensible): Vital Records Role | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Reference to the person who reported the parent's age. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reporter" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile) | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr" | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Identifier | Medical Record Number |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Medical record number Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | SSN if available and appropriate to send |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | The use of a human name Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When "name not chosen" use code "temp-unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When "name not chosen" use code "temp-unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Surname suffix This repeating element order: Suffixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumanName | current legal name |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumanName | Name prior to first marriage |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() |
SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() |
SΣ | 1..1 | date | Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time]. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Use if only partial date and time of birth is known URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Time of Birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for date of birth. Binding: Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not, dateTime is preferred Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
?!ΣC | 0..1 | boolean | Boolean indicator. True if the individual is deceased. fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
SΣ | 0..* | Address | An address for the individual |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
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: Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Vital Records (required) |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() |
S | 0..1 | integer | If not single birth - born first, second, third, etc. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. Binding: Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |
![]() ![]() ![]() |
0..* | BackboneElement | 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 |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.extension:birthsex.value[x] | required | ValueSetSexAssignedAtBirthVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr from this IG | |
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:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x] | extensible | ValueSetRoleVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr from this IG | |
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.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 |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | PatientVitalRecords | 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. | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Sex Binding: Sex Assigned At Birth Vital Records (required) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Address | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | County of birth URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | State of Birth Binding: States, Territories and Provinces Vital Records (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Jurisdiction of Birth URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Jurisdictions Vital Records (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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) Binding: Birthplace Country Vital Records (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() ![]() |
0..2 | (Complex) | The mother or father's reported age at the time of delivery of the child URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
2..3 | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reportedAge" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Reported age | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | year Fixed Value: a | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "motherOrFather" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code Binding: Role Vital Records (extensible): Vital Records Role | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Reference to the person who reported the parent's age. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reporter" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile) | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr" | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Identifier | Medical Record Number | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Identifier type code | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Medical record number 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) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | SSN if available and appropriate to send | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | 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Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | The use of a human name Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When "name not chosen" use code "temp-unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When "name not chosen" use code "temp-unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Surname suffix 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Σ | 0..1 | HumanName | current legal name | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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Σ | 0..1 | HumanName | Name prior to first marriage | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | 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 | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | date | Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time]. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Use if only partial date and time of birth is known URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Time of Birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for date of birth. Binding: Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |||||
![]() ![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not, dateTime is preferred Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
?!ΣC | 0..1 | boolean | Boolean indicator. True if the individual is deceased. fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Primitive value for boolean | |||||
![]() ![]() ![]() |
SΣ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
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: Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Vital Records (required) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Vital Records (required) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | 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. | |||||
![]() ![]() ![]() |
S | 0..1 | integer | If not single birth - born first, second, third, etc. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. Binding: Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | BackboneElement | 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 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.extension:birthsex.value[x] | required | ValueSetSexAssignedAtBirthVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr from this IG | ||||
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 Country Codes Vital Records)http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr from this IG | ||||
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x] | extensible | ValueSetRoleVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr from this IG | ||||
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 |
This structure is derived from PatientVitalRecords
Differential View
This structure is derived from PatientVitalRecords
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PatientVitalRecords | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | USCoreRaceExtension | US Core Race Extension |
![]() ![]() ![]() ![]() |
S | 0..1 | USCoreEthnicityExtension | US Core ethnicity Extension |
![]() ![]() ![]() ![]() |
S | 1..1 | USCoreBirthSexExtension | Extension |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Sex Binding: Sex Assigned At Birth Vital Records (required) | |
![]() ![]() ![]() ![]() |
S | 0..1 | PatBirthPlace(5.1.0) | Place of Birth for patient |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | ExtensionDistrictCodeVitalRecords | County of birth | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | State of Birth | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | ExtensionLocationJurisdictionIdVitalRecords | Jurisdiction of Birth | |
![]() ![]() ![]() ![]() |
0..2 | ExtensionReportedParentAgeAtDeliveryVitalRecords | The mother or father's reported age at the time of delivery of the child | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Reported age | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | Identifier | Medical Record Number |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Identifier type code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Medical record number | |
![]() ![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() ![]() |
0..1 | code | The use of a human name | |
![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | DataAbsentReason(5.1.0) | When "name not chosen" use code "temp-unknown" | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | DataAbsentReason(5.1.0) | When "name not chosen" use code "temp-unknown" | |
![]() ![]() ![]() ![]() |
0..* | string | Surname suffix | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | HumanName | current legal name | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() |
0..1 | HumanName | Name prior to first marriage | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() |
1..1 | date | Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time]. | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | ExtensionPartialDateTimeVitalRecords | Use if only partial date and time of birth is known |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | PatBirthTime(5.1.0) | Time of Birth |
![]() ![]() ![]() |
S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not, dateTime is preferred |
![]() ![]() ![]() |
S | 0..1 | integer | If not single birth - born first, second, third, etc. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | ExtensionBypassEditFlagVitalRecords | BypassEditFlag Vital Records | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | PatMultipleBirthTotal | Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |
![]() |
Path | Conformance | ValueSet | URI |
Patient.extension:birthsex.value[x] | required | ValueSetSexAssignedAtBirthVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | PatientVitalRecords | 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. |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Sex Binding: Sex Assigned At Birth Vital Records (required) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Address | Value of extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 | string | State of Birth Binding: States, Territories and Provinces Vital Records (required) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Jurisdiction of Birth URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Jurisdictions Vital Records (required) | |
![]() ![]() ![]() ![]() |
0..2 | (Complex) | The mother or father's reported age at the time of delivery of the child URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |
![]() ![]() ![]() ![]() ![]() |
2..3 | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reportedAge" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Reported age | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "motherOrFather" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code Binding: Role Vital Records (extensible): Vital Records Role | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Reference to the person who reported the parent's age. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reporter" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile) | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr" | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Identifier | Medical Record Number |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Medical record number Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | SSN if available and appropriate to send |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | The use of a human name Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When "name not chosen" use code "temp-unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When "name not chosen" use code "temp-unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Surname suffix This repeating element order: Suffixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumanName | current legal name |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumanName | Name prior to first marriage |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() |
SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() |
SΣ | 1..1 | date | Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time]. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Use if only partial date and time of birth is known URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Time of Birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for date of birth. Binding: Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not, dateTime is preferred Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
?!ΣC | 0..1 | boolean | Boolean indicator. True if the individual is deceased. fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
SΣ | 0..* | Address | An address for the individual |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
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: Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Vital Records (required) |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() |
S | 0..1 | integer | If not single birth - born first, second, third, etc. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. Binding: Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |
![]() ![]() ![]() |
0..* | BackboneElement | 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 |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.extension:birthsex.value[x] | required | ValueSetSexAssignedAtBirthVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr from this IG | |
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:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x] | extensible | ValueSetRoleVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr from this IG | |
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.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 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | PatientVitalRecords | 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. | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Sex Binding: Sex Assigned At Birth Vital Records (required) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Address | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | County of birth URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | State of Birth Binding: States, Territories and Provinces Vital Records (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Jurisdiction of Birth URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Jurisdictions Vital Records (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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) Binding: Birthplace Country Vital Records (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() ![]() |
0..2 | (Complex) | The mother or father's reported age at the time of delivery of the child URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
2..3 | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reportedAge" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Reported age | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | year Fixed Value: a | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Extension | Extension | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "motherOrFather" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code Binding: Role Vital Records (extensible): Vital Records Role | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Reference to the person who reported the parent's age. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reporter" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile) | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr" | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Identifier | Medical Record Number | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Identifier type code | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Medical record number 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) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | SSN if available and appropriate to send | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | 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Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | The use of a human name Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When "name not chosen" use code "temp-unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When "name not chosen" use code "temp-unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Surname suffix 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Σ | 0..1 | HumanName | current legal name | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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Σ | 0..1 | HumanName | Name prior to first marriage | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | 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 | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | date | Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time]. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Use if only partial date and time of birth is known URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Time of Birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for date of birth. Binding: Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |||||
![]() ![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not, dateTime is preferred Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
?!ΣC | 0..1 | boolean | Boolean indicator. True if the individual is deceased. fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Primitive value for boolean | |||||
![]() ![]() ![]() |
SΣ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
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: Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length: 1048576 | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Vital Records (required) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Vital Records (required) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | 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. | |||||
![]() ![]() ![]() |
S | 0..1 | integer | If not single birth - born first, second, third, etc. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. Binding: Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | BackboneElement | 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 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.extension:birthsex.value[x] | required | ValueSetSexAssignedAtBirthVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr from this IG | ||||
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 Country Codes Vital Records)http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr from this IG | ||||
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x] | extensible | ValueSetRoleVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr from this IG | ||||
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 |
This structure is derived from PatientVitalRecords
Other representations of profile: CSV, Excel, Schematron