Vital Records Common Library (VRCL) FHIR Implementation Guide
2.0.0 - STU2 United States of America flag

This page is part of the Vital Records Common Profile Library (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Patient - Child Vital Records

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-child-vr Version: 2.0.0
Active as of 2024-10-11 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)
    • use not-applicable if the name hasn't been chosen

Note: The PatientChild profile is based on the US Core Patient Profile which requires gender. A value of 'unknown' will satisfy this requirement. Complete vital record submissions may fail FHIR validation due to lack of a value for gender.

IJE Mapping

Natality
Use Case # Description IJE Name Field Type Value Set/Comments
Natality 1 Date of Birth (Infant)--Year IDOB_YR birthDate.value 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 or extension[birthPlace].value[x].state.extension[nationalReportingJurisdictionId] string ValueSetStatesTerritoriesAndProvincesVitalRecords in state field or ValueSetJurisdictionVitalRecords in extension
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 Gender *NO IJE MAPPING* gender codeable USCorePatient requires gender - can be 'unknown'. See [Note on Gender]
Natality 8 Date of Birth (Infant)--Month IDOB_MO birthDate.value date See note on birth date and time
Natality 9 Date of Birth (Infant)--Day IDOB_DY birthDate.value 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

Form Mapping

Form Mapping
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
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

Usage:

Formal Views of Profile Content

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

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
childNotDeceased: Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:birthsex 1..1 USCoreBirthSexExtension Extension
..... extension 0..0
..... value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
.... extension:birthPlace 0..1 PatBirthPlace(5.1.0) Place of Birth for patient
..... value[x]
...... city 0..1 string City of Birth
...... district 0..1 string District of Birth
....... Slices for extension Content/Rules for all slices
........ extension:districtCode 0..1 ExtensionDistrictCodeVitalRecords County of birth
...... state 0..1 string State of Birth
....... Slices for extension Content/Rules for all slices
........ extension:nationalReportingJurisdictionId 0..1 ExtensionLocationJurisdictionIdVitalRecords Jurisdiction of Birth
.... extension:parentReportedAgeAtDelivery 0..2 ExtensionReportedParentAgeAtDeliveryVitalRecords The mother or father's reported age at the time of delivery of the child
..... Slices for extension Content/Rules for all slices
...... extension:reportedAge 1..1 Extension Extension
....... value[x] 1..1 Quantity Reported age
...... extension:motherOrFather 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Indicates mother/Father code
... Slices for identifier Content/Rules for all slices
.... identifier:MRN 0..* Identifier Medical Record Number
..... type
...... coding
....... code 0..1 code Identifier type code
..... value 1..1 string Medical record number
.... use 0..1 code The use of a human name
.... family 1..1 string Family name (often called 'Surname')
..... Slices for extension Content/Rules for all slices
...... extension:dataAbsentReason 0..1 DataAbsentReason(5.1.0) When "name not chosen" use code "temp-unknown"
.... given
..... Slices for extension Content/Rules for all slices
...... extension:dataAbsentReason 0..1 DataAbsentReason(5.1.0) When "name not chosen" use code "temp-unknown"
.... suffix 0..* string Surname suffix
... Slices for name Content/Rules for all slices
.... name:currentLegalName 0..1 HumanName current legal name
..... family 1..1 string Family name (often called 'Surname')
.... name:namePriorToFirstMarriage 0..1 HumanName Name prior to first marriage
..... family 1..1 string Family name (often called 'Surname')
... birthDate 1..1 date Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... Slices for extension Content/Rules for all slices
..... extension:partialDateTime 0..1 ExtensionPartialDateTimeVitalRecords Use if only partial date and time of birth is known
..... extension:birthTime 0..1 PatBirthTime(5.1.0) Time of Birth
... deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not, dateTime is preferred
... multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
.... Slices for extension Content/Rules for all slices
..... extension:bypassEditFlag 0..1 ExtensionBypassEditFlagVitalRecords BypassEditFlag Vital Records
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
..... extension:multipleBirthTotal 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.
...... extension 0..0
...... value[x] 1..1 positiveInt Plurality

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.extension:birthsex.value[x]requiredValueSetSexAssignedAtBirthVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
from this IG

Constraints

IdGradePath(s)DetailsRequirements
childNotDeceasederrorPatientPatients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
: deceased.exists() implies deceased = false
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 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.
childNotDeceased: Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... birthsex 1..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
..... value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
.... genderIdentity 0..1 CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 Address Value of extension
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... city Σ 0..1 string City of Birth
Example General: Erewhon
....... Slices for extension Content/Rules for all slices
........ cityCode 0..1 positiveInt City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
...... district Σ 0..1 string District of Birth
Example General: Madison
....... Slices for extension Content/Rules for all slices
........ districtCode 0..1 positiveInt County of birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
...... state Σ 0..1 string State of Birth
Binding: Value Set - States, Territories and Provinces Vital Records (required)
....... Slices for extension Content/Rules for all slices
........ nationalReportingJurisdictionId 0..1 string Jurisdiction of Birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
.... parentReportedAgeAtDelivery 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
..... Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
...... extension:reportedAge 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "reportedAge"
....... value[x] 1..1 Quantity Reported age
........ value Σ 1..1 decimal Numerical value (with implicit precision)
........ comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... extension:motherOrFather 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "motherOrFather"
....... value[x] 1..1 CodeableConcept Indicates mother/Father code
Binding: Value Set - Role Vital Records (extensible): Vital Records Role

...... extension:reporter 0..1 Extension Reference to the person who reported the parent's age.
....... extension 0..0
....... url 1..1 uri "reporter"
....... value[x] 1..1 Reference(US Core Patient Profile | US Core RelatedPerson Profile) Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:MRN SΣ 0..* Identifier Medical Record Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string Medical record number
Example General: 123456
.... identifier:SSN SΣ 0..1 Identifier SSN if available and appropriate to send
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use
.... name:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code The use of a human name
Binding: NameUse (required): The use of a human name.

..... family SΣC 1..1 string Family name (often called 'Surname')
...... Slices for extension Content/Rules for all slices
....... dataAbsentReason 0..1 code When "name not chosen" use code "temp-unknown"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... Slices for extension Content/Rules for all slices
....... dataAbsentReason 0..1 code When "name not chosen" use code "temp-unknown"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... suffix Σ 0..* string Surname suffix
This repeating element order: Suffixes appear in the correct order for presenting the name
.... name:currentLegalName SΣ 0..1 HumanName current legal name
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family SΣC 1..1 string Family name (often called 'Surname')
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... name:namePriorToFirstMarriage SΣ 0..1 HumanName Name prior to first marriage
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: maiden
..... family SΣC 1..1 string Family name (often called 'Surname')
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom Σ 0..* ContactPoint A contact detail for the individual
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 1..1 date Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... Slices for extension Content/Rules for all slices
..... partialDateTime 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
..... birthTime 0..1 dateTime Time of Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
..... bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for date of birth.
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not, dateTime is preferred
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!ΣC 0..1 boolean Boolean indicator. True if the individual is deceased.
fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased.
..... Slices for extension Content/Rules for all slices
...... fetalDeath 0..1 boolean Boolean indicator. True if the Patient died as a fetus.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
... address SΣ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... withinCityLimitsIndicator 0..1 Coding Used to indicate whether or not an address is within city limits.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)


..... predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... Slices for extension Content/Rules for all slices
...... cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Value Set - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
.... Slices for extension Content/Rules for all slices
..... bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

..... multipleBirthTotal 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
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
...... value[x] 1..1 positiveInt Plurality
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.extension:birthsex.value[x]requiredValueSetSexAssignedAtBirthVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
from this IG
Patient.extension:birthPlace.value[x].userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.extension:birthPlace.value[x].staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
from this IG
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x]extensibleValueSetRoleVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr
from this IG
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:MRN.typeextensiblePattern: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:SSN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:SSN.typeextensiblePattern: SS
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:currentLegalName.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:namePriorToFirstMarriage.userequiredFixed Value: maiden
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]requiredValueSetDateOfBirthEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
from this IG
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
from this IG
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]requiredValueSetPluralityEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
from this IG
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
childNotDeceasederrorPatientPatients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
: deceased.exists() implies deceased = false
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 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.
childNotDeceased: Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... birthsex 1..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
..... value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
.... genderIdentity 0..1 CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 Address Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
...... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... city Σ 0..1 string City of Birth
Example General: Erewhon
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ cityCode 0..1 positiveInt City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
....... value 0..1 string Primitive value for string
Max Length: 1048576
...... district Σ 0..1 string District of Birth
Example General: Madison
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ districtCode 0..1 positiveInt County of birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
....... value 0..1 string Primitive value for string
Max Length: 1048576
...... state Σ 0..1 string State of Birth
Binding: Value Set - States, Territories and Provinces Vital Records (required)
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ nationalReportingJurisdictionId 0..1 string Jurisdiction of Birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
....... value 0..1 string Primitive value for string
Max Length: 1048576
...... postalCode Σ 0..1 string Postal code for area
Example General: 9132
...... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Value Set - Birthplace Country Vital Records (required)
...... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... parentReportedAgeAtDelivery 0..2 (Complex) 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
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
...... extension:reportedAge 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reportedAge"
....... value[x] 1..1 Quantity Reported age
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ value Σ 1..1 decimal Numerical value (with implicit precision)
........ comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

........ unit Σ 0..1 string Unit representation
........ system ΣC 0..1 uri System that defines coded unit form
........ code Σ 0..1 code year
Fixed Value: a
...... extension:motherOrFather 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "motherOrFather"
....... value[x] 1..1 CodeableConcept Indicates mother/Father code
Binding: Value Set - Role Vital Records (extensible): Vital Records Role

...... extension:reporter 0..1 Extension Reference to the person who reported the parent's age.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reporter"
....... value[x] 1..1 Reference(US Core Patient Profile | US Core RelatedPerson Profile) Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:MRN SΣ 0..* Identifier Medical Record Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Identifier type code
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string Medical record number
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:SSN SΣ 0..1 Identifier SSN if available and appropriate to send
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use
.... name:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code The use of a human name
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family SΣC 1..1 string Family name (often called 'Surname')
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... dataAbsentReason 0..1 code When "name not chosen" use code "temp-unknown"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value 0..1 string Primitive value for string
Max Length: 1048576
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... dataAbsentReason 0..1 code When "name not chosen" use code "temp-unknown"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value 0..1 string Primitive value for string
Max Length: 1048576
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Surname suffix
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:currentLegalName SΣ 0..1 HumanName current legal name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ 0..1 string Text representation of the full name
..... family SΣC 1..1 string Family name (often called 'Surname')
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:namePriorToFirstMarriage SΣ 0..1 HumanName Name prior to first marriage
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: maiden
..... text Σ 0..1 string Text representation of the full name
..... family SΣC 1..1 string Family name (often called 'Surname')
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 1..1 date Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... partialDateTime 0..1 (Complex) 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
..... birthTime 0..1 dateTime Time of Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
..... bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for date of birth.
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

.... value 0..1 date Primitive value for date
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not, dateTime is preferred
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!ΣC 0..1 boolean Boolean indicator. True if the individual is deceased.
fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... fetalDeath 0..1 boolean Boolean indicator. True if the Patient died as a fetus.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
..... value 0..1 boolean Primitive value for boolean
... address SΣ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... withinCityLimitsIndicator 0..1 Coding Used to indicate whether or not an address is within city limits.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)


..... predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
..... value 0..1 string Primitive value for string
Max Length: 1048576
.... district Σ 0..1 string District name (aka county)
Example General: Madison
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
..... value 0..1 string Primitive value for string
Max Length: 1048576
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Value Set - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Value Set - Residence Country Vital Records (required)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

..... multipleBirthTotal 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
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
...... value[x] 1..1 positiveInt Plurality
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.extension:birthsex.value[x]requiredValueSetSexAssignedAtBirthVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
from this IG
Patient.extension:birthPlace.value[x].userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.extension:birthPlace.value[x].typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.extension:birthPlace.value[x].staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
from this IG
Patient.extension:birthPlace.value[x].countryrequiredValueSetBirthplaceCountryVitalRecords (a valid code from Code System - Country Codes Vital Records)
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr
from this IG
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x]extensibleValueSetRoleVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr
from this IG
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:MRN.typeextensiblePattern: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:SSN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:SSN.typeextensiblePattern: SS
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:currentLegalName.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:namePriorToFirstMarriage.userequiredFixed Value: maiden
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]requiredValueSetDateOfBirthEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
from this IG
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
from this IG
Patient.address.countryrequiredValueSetResidenceCountryVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
from this IG
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]requiredValueSetPluralityEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
from this IG
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
childNotDeceasederrorPatientPatients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
: deceased.exists() implies deceased = false

This structure is derived from PatientVitalRecords

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 1 element
Prohibited: 2 elements

Differential View

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
childNotDeceased: Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:birthsex 1..1 USCoreBirthSexExtension Extension
..... extension 0..0
..... value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
.... extension:birthPlace 0..1 PatBirthPlace(5.1.0) Place of Birth for patient
..... value[x]
...... city 0..1 string City of Birth
...... district 0..1 string District of Birth
....... Slices for extension Content/Rules for all slices
........ extension:districtCode 0..1 ExtensionDistrictCodeVitalRecords County of birth
...... state 0..1 string State of Birth
....... Slices for extension Content/Rules for all slices
........ extension:nationalReportingJurisdictionId 0..1 ExtensionLocationJurisdictionIdVitalRecords Jurisdiction of Birth
.... extension:parentReportedAgeAtDelivery 0..2 ExtensionReportedParentAgeAtDeliveryVitalRecords The mother or father's reported age at the time of delivery of the child
..... Slices for extension Content/Rules for all slices
...... extension:reportedAge 1..1 Extension Extension
....... value[x] 1..1 Quantity Reported age
...... extension:motherOrFather 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Indicates mother/Father code
... Slices for identifier Content/Rules for all slices
.... identifier:MRN 0..* Identifier Medical Record Number
..... type
...... coding
....... code 0..1 code Identifier type code
..... value 1..1 string Medical record number
.... use 0..1 code The use of a human name
.... family 1..1 string Family name (often called 'Surname')
..... Slices for extension Content/Rules for all slices
...... extension:dataAbsentReason 0..1 DataAbsentReason(5.1.0) When "name not chosen" use code "temp-unknown"
.... given
..... Slices for extension Content/Rules for all slices
...... extension:dataAbsentReason 0..1 DataAbsentReason(5.1.0) When "name not chosen" use code "temp-unknown"
.... suffix 0..* string Surname suffix
... Slices for name Content/Rules for all slices
.... name:currentLegalName 0..1 HumanName current legal name
..... family 1..1 string Family name (often called 'Surname')
.... name:namePriorToFirstMarriage 0..1 HumanName Name prior to first marriage
..... family 1..1 string Family name (often called 'Surname')
... birthDate 1..1 date Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... Slices for extension Content/Rules for all slices
..... extension:partialDateTime 0..1 ExtensionPartialDateTimeVitalRecords Use if only partial date and time of birth is known
..... extension:birthTime 0..1 PatBirthTime(5.1.0) Time of Birth
... deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not, dateTime is preferred
... multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
.... Slices for extension Content/Rules for all slices
..... extension:bypassEditFlag 0..1 ExtensionBypassEditFlagVitalRecords BypassEditFlag Vital Records
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
..... extension:multipleBirthTotal 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.
...... extension 0..0
...... value[x] 1..1 positiveInt Plurality

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.extension:birthsex.value[x]requiredValueSetSexAssignedAtBirthVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
from this IG

Constraints

IdGradePath(s)DetailsRequirements
childNotDeceasederrorPatientPatients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
: deceased.exists() implies deceased = false

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 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.
childNotDeceased: Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... birthsex 1..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
..... value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
.... genderIdentity 0..1 CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 Address Value of extension
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... city Σ 0..1 string City of Birth
Example General: Erewhon
....... Slices for extension Content/Rules for all slices
........ cityCode 0..1 positiveInt City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
...... district Σ 0..1 string District of Birth
Example General: Madison
....... Slices for extension Content/Rules for all slices
........ districtCode 0..1 positiveInt County of birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
...... state Σ 0..1 string State of Birth
Binding: Value Set - States, Territories and Provinces Vital Records (required)
....... Slices for extension Content/Rules for all slices
........ nationalReportingJurisdictionId 0..1 string Jurisdiction of Birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
.... parentReportedAgeAtDelivery 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
..... Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
...... extension:reportedAge 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "reportedAge"
....... value[x] 1..1 Quantity Reported age
........ value Σ 1..1 decimal Numerical value (with implicit precision)
........ comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... extension:motherOrFather 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "motherOrFather"
....... value[x] 1..1 CodeableConcept Indicates mother/Father code
Binding: Value Set - Role Vital Records (extensible): Vital Records Role

...... extension:reporter 0..1 Extension Reference to the person who reported the parent's age.
....... extension 0..0
....... url 1..1 uri "reporter"
....... value[x] 1..1 Reference(US Core Patient Profile | US Core RelatedPerson Profile) Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:MRN SΣ 0..* Identifier Medical Record Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string Medical record number
Example General: 123456
.... identifier:SSN SΣ 0..1 Identifier SSN if available and appropriate to send
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use
.... name:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code The use of a human name
Binding: NameUse (required): The use of a human name.

..... family SΣC 1..1 string Family name (often called 'Surname')
...... Slices for extension Content/Rules for all slices
....... dataAbsentReason 0..1 code When "name not chosen" use code "temp-unknown"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... Slices for extension Content/Rules for all slices
....... dataAbsentReason 0..1 code When "name not chosen" use code "temp-unknown"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... suffix Σ 0..* string Surname suffix
This repeating element order: Suffixes appear in the correct order for presenting the name
.... name:currentLegalName SΣ 0..1 HumanName current legal name
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family SΣC 1..1 string Family name (often called 'Surname')
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... name:namePriorToFirstMarriage SΣ 0..1 HumanName Name prior to first marriage
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: maiden
..... family SΣC 1..1 string Family name (often called 'Surname')
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom Σ 0..* ContactPoint A contact detail for the individual
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 1..1 date Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... Slices for extension Content/Rules for all slices
..... partialDateTime 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
..... birthTime 0..1 dateTime Time of Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
..... bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for date of birth.
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not, dateTime is preferred
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!ΣC 0..1 boolean Boolean indicator. True if the individual is deceased.
fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased.
..... Slices for extension Content/Rules for all slices
...... fetalDeath 0..1 boolean Boolean indicator. True if the Patient died as a fetus.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
... address SΣ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... withinCityLimitsIndicator 0..1 Coding Used to indicate whether or not an address is within city limits.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)


..... predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... Slices for extension Content/Rules for all slices
...... cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Value Set - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
.... Slices for extension Content/Rules for all slices
..... bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

..... multipleBirthTotal 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
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
...... value[x] 1..1 positiveInt Plurality
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.extension:birthsex.value[x]requiredValueSetSexAssignedAtBirthVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
from this IG
Patient.extension:birthPlace.value[x].userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.extension:birthPlace.value[x].staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
from this IG
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x]extensibleValueSetRoleVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr
from this IG
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:MRN.typeextensiblePattern: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:SSN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:SSN.typeextensiblePattern: SS
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:currentLegalName.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:namePriorToFirstMarriage.userequiredFixed Value: maiden
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]requiredValueSetDateOfBirthEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
from this IG
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
from this IG
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]requiredValueSetPluralityEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
from this IG
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
childNotDeceasederrorPatientPatients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
: deceased.exists() implies deceased = false

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 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.
childNotDeceased: Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... birthsex 1..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
..... value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
.... genderIdentity 0..1 CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 Address Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
...... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... city Σ 0..1 string City of Birth
Example General: Erewhon
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ cityCode 0..1 positiveInt City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
....... value 0..1 string Primitive value for string
Max Length: 1048576
...... district Σ 0..1 string District of Birth
Example General: Madison
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ districtCode 0..1 positiveInt County of birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
....... value 0..1 string Primitive value for string
Max Length: 1048576
...... state Σ 0..1 string State of Birth
Binding: Value Set - States, Territories and Provinces Vital Records (required)
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ nationalReportingJurisdictionId 0..1 string Jurisdiction of Birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
....... value 0..1 string Primitive value for string
Max Length: 1048576
...... postalCode Σ 0..1 string Postal code for area
Example General: 9132
...... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Value Set - Birthplace Country Vital Records (required)
...... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... parentReportedAgeAtDelivery 0..2 (Complex) 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
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
...... extension:reportedAge 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reportedAge"
....... value[x] 1..1 Quantity Reported age
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ value Σ 1..1 decimal Numerical value (with implicit precision)
........ comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

........ unit Σ 0..1 string Unit representation
........ system ΣC 0..1 uri System that defines coded unit form
........ code Σ 0..1 code year
Fixed Value: a
...... extension:motherOrFather 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "motherOrFather"
....... value[x] 1..1 CodeableConcept Indicates mother/Father code
Binding: Value Set - Role Vital Records (extensible): Vital Records Role

...... extension:reporter 0..1 Extension Reference to the person who reported the parent's age.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reporter"
....... value[x] 1..1 Reference(US Core Patient Profile | US Core RelatedPerson Profile) Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:MRN SΣ 0..* Identifier Medical Record Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Identifier type code
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string Medical record number
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:SSN SΣ 0..1 Identifier SSN if available and appropriate to send
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use
.... name:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code The use of a human name
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family SΣC 1..1 string Family name (often called 'Surname')
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... dataAbsentReason 0..1 code When "name not chosen" use code "temp-unknown"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value 0..1 string Primitive value for string
Max Length: 1048576
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... dataAbsentReason 0..1 code When "name not chosen" use code "temp-unknown"
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value 0..1 string Primitive value for string
Max Length: 1048576
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Surname suffix
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:currentLegalName SΣ 0..1 HumanName current legal name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ 0..1 string Text representation of the full name
..... family SΣC 1..1 string Family name (often called 'Surname')
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:namePriorToFirstMarriage SΣ 0..1 HumanName Name prior to first marriage
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: maiden
..... text Σ 0..1 string Text representation of the full name
..... family SΣC 1..1 string Family name (often called 'Surname')
..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 1..1 date Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... partialDateTime 0..1 (Complex) 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
..... birthTime 0..1 dateTime Time of Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
..... bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for date of birth.
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

.... value 0..1 date Primitive value for date
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not, dateTime is preferred
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!ΣC 0..1 boolean Boolean indicator. True if the individual is deceased.
fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... fetalDeath 0..1 boolean Boolean indicator. True if the Patient died as a fetus.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
..... value 0..1 boolean Primitive value for boolean
... address SΣ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... withinCityLimitsIndicator 0..1 Coding Used to indicate whether or not an address is within city limits.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)


..... predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
..... value 0..1 string Primitive value for string
Max Length: 1048576
.... district Σ 0..1 string District name (aka county)
Example General: Madison
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
..... value 0..1 string Primitive value for string
Max Length: 1048576
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Value Set - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Value Set - Residence Country Vital Records (required)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
...... value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

..... multipleBirthTotal 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
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
...... value[x] 1..1 positiveInt Plurality
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.extension:birthsex.value[x]requiredValueSetSexAssignedAtBirthVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
from this IG
Patient.extension:birthPlace.value[x].userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.extension:birthPlace.value[x].typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.extension:birthPlace.value[x].staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
from this IG
Patient.extension:birthPlace.value[x].countryrequiredValueSetBirthplaceCountryVitalRecords (a valid code from Code System - Country Codes Vital Records)
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr
from this IG
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x]extensibleValueSetRoleVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr
from this IG
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:MRN.typeextensiblePattern: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:SSN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:SSN.typeextensiblePattern: SS
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:currentLegalName.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:namePriorToFirstMarriage.userequiredFixed Value: maiden
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]requiredValueSetDateOfBirthEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
from this IG
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
from this IG
Patient.address.countryrequiredValueSetResidenceCountryVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
from this IG
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]requiredValueSetPluralityEditFlagsVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
from this IG
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
childNotDeceasederrorPatientPatients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false
: deceased.exists() implies deceased = false

This structure is derived from PatientVitalRecords

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 1 element
Prohibited: 2 elements

 

Other representations of profile: CSV, Excel, Schematron