Vital Records Death Reporting (VRDR) FHIR Implementation Guide
3.0.0-ballot - ballot United States of America flag

This page is part of the Vital Records Death Reporting FHIR Implementation Guide (v3.0.0-ballot: STU 3 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.2.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Decedent

Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-decedent Version: 3.0.0-ballot
Draft as of 2024-04-05 Computable Name: Decedent
Other Identifiers: OID:2.16.840.1.113883.4.642.40.10.42.37

Decedent (PatientVitalRecords)

The Decedent profile contains basic information about the decedent, including data that are essential to the death record.

Note: The Decedent profile is based on the US Core Patient Profile which requires gender. The death record submission use case uses NCHS’s definition of sex at time of death which is different than gender. Complete death record submissions may fail FHIR validation due to lack of a value for gender.

IJE Mapping

Mortality (Decedent)
Use Case # Description IJE Name Field Type Value Set/Comments
Mortality 7 Decedent's Legal Name--Given GNAME name.given , name.use = official string -
Mortality 8 Decedent's Legal Name--Middle MNAME name.given , name.use = official (first letter) string -
Mortality 9 Decedent's Legal Name--Last LNAME name.family , name.use = official. (absence is equivalent to 'UNKNOWN'.) string -
Mortality 10 Decedent's Legal Name--Suffix SUFF name.suffix , name.use = official string -
Mortality 13 Sex SEX extension[NVSS-SexAtDeath] codeable AdministrativeGenderVS
Mortality NA Gender *NO IJE MAPPING* gender codeable AdministrativeGenderVS - See Note on Decedent Gender
Mortality 15 Social Security Number SSN identifier.value where system = 'http://hl7.org/fhir/sid/us-ssn and type.coding.code="SB" string -
Mortality 19 Date of Birth--Year DOB_YR birthDate dateTime See PartialDatesAndTimes
Mortality 20 Date of Birth--Month DOB_MO birthDate dateTime See PartialDatesAndTimes
Mortality 21 Date of Birth--Day DOB_DY birthDate dateTime See PartialDatesAndTimes
Mortality 22 Birthplace--Country BPLACE_CNT extension[patient-birthPlace].value[x].country string ValueSetBirthplaceCountryVitalRecords
Mortality 23 State, U.S. Territory or Canadian Province of Birth - code BPLACE_ST extension[patient-birthPlace].value[x].state string ValueSetStatesTerritoriesAndProvincesVitalRecords
Mortality 24 Decedent's Residence--City CITYC address.city.extension[cityCode] integer see CityCodes
Mortality 25 Decedent's Residence--County COUNTYC address.district.extension[districtCode] integer see CountyCodes
Mortality 26 State, U.S. Territory or Canadian Province of Decedent's residence - code STATEC address.state string ValueSetStatesTerritoriesAndProvincesVitalRecords
Mortality 27 Decedent's Residence--Country COUNTRYC address.country string ValueSetResidenceCountryVitalRecords
Mortality 28 Decedent's Residence--Inside City Limits LIMITS address.city.extension[withinCityLimits] codeable ValueSetYesNoUnknownVitalRecords
Mortality 29 Marital Status MARITAL maritalStatus codeable ValueSetMaritalStatusVitalRecords
Mortality 30 Marital Status--Edit Flag MARITAL_BYPASS maritalStatus.extension[BypassEditFlag] codeable EditBypass0124VS
Mortality 143 Decedent's spouse living at decedent's DOD? SPOUSELV extension[SpouseAlive] codeable SpouseAliveVS
Mortality 146 Decedent's Residence - Street number STNUM_R address.extension[stnum] string -
Mortality 147 Decedent's Residence - Pre Directional PREDIR_R address.extension[predir] string -
Mortality 148 Decedent's Residence - Street name STNAME_R address.extension[stname] string -
Mortality 149 Decedent's Residence - Street designator STDESIG_R address.extension[stdesig] string -
Mortality 150 Decedent's Residence - Post Directional POSTDIR_R address.extension[postdir] string -
Mortality 151 Decedent's Residence - Unit or apt number UNITNUM_R address.extension[unitnum] string -
Mortality 152 Decedent's Residence - City or Town name CITYTEXT_R address.city string -
Mortality 153 Decedent's Residence - ZIP code ZIP9_R address.postalCode string -
Mortality 154 Decedent's Residence - County COUNTYTEXT_R address.district string -
Mortality 155 Decedent's Residence - State name STATETEXT_R address.state (expanded from 2 letter code) string See StateLiterals
Mortality 156 Decedent's Residence - COUNTRY name COUNTRYTEXT_R address.country (expanded from 2 letter code) string See CountryLiterals
Mortality 157 Long string address for decedent's place of residence same as above but allows states to choose the way they capture information. ADDRESS_R address.line[0] string -
Mortality 166 Middle Name of Decedent DMIDDLE name.given , name.use = official string -
Mortality 194 Decedent's Maiden Name DMAIDEN name.text , name.use=maiden string -
Mortality 195 Decedent's Birth Place City - Code DBPLACECITYCODE extension[patient-birthPlace].value[x].city.extension[cityCode] integer see CityCodes
Mortality 196 Decedent's Birth Place City - Literal DBPLACECITY extension[patient-birthPlace].value[x].city string -
Mortality 201 Informant's Relationship INFORMRELATE contact.type.text string (30 characters) -
Mortality 238 State, U.S. Territory or Canadian Province of Birth - literal STATEBTH extension[patient-birthPlace].value[x].state or extension[patient-birthPlace].value[x].state.extension[nationalReportingJurisdictionId] if present (expanded from 2 letter code) string See StateLiterals
Mortality 246 Marital Descriptor MARITAL_DESCRIP maritalStatus.text string -

Mortality Roster
Use Case # Description IJE Name Field Type Value Set/Comments
Mortality Roster 1 State, U.S. Territory or Canadian Province of Birth - literal STATEBTH extension[patient-birthPlace].value[x].state or extension[patient-birthPlace].value[x].state.extension[nationalReportingJurisdictionId] if present (expanded from 2 letter code) string See StateLiterals
Mortality Roster 2 State, U.S. Territory or Canadian Province of Birth - code BPLACE_ST extension[patient-birthPlace].value[x].state or extension[patient-birthPlace].value[x].state.extension[nationalReportingJurisdictionId] if present string ValueSetJurisdictionVitalRecords
Mortality Roster 3 Decedent's Legal Name--Given GNAME name.given , name.use = official string See Note on Decedent Name
Mortality Roster 4 Decedent's Legal Name--Middle MIDNAME name.given , name.use = official (first letter) string See Note on Decedent Name
Mortality Roster 5 Decedent's Legal Name--Last LNAME name.family , name.use = official string See Note on Decedent Name
Mortality Roster 11 Date of Birth--Month DOB_MO birthDate dateTime See PartialDatesAndTimes
Mortality Roster 12 Date of Birth--Day DOB_DY birthDate dateTime See PartialDatesAndTimes
Mortality Roster 13 Date of Birth--Year DOB_YR birthDate dateTime See PartialDatesAndTimes
Mortality Roster 14 Sex SEX extension[NVSS-SexAtDeath] codeable AdministrativeGenderVS
Mortality Roster NA Gender *NO IJE MAPPING* gender codeable AdministrativeGenderVS - See Note on Decedent Gender
Mortality Roster 22 Decedent's Suffix SUFF name.suffix , name.use = official string -
Mortality Roster 26 Decedent's Maiden Name DMAIDEN name.text , name.use=maiden string
Mortality Roster 27 State, U.S. Territory or Canadian Province of Decedent's Residence - literal STATETEXT_R address.state (expanded from 2 letter code) string See StateLiterals
Mortality Roster 28 State, U.S. Territory or Canadian Province of Decedent's Residence - code STATEC address.state string ValueSetStatesTerritoriesAndProvincesVitalRecords
Mortality Roster 29 Birthplace Country - Code BPLACE_CT extension[patient-birthPlace].value[x].country string ValueSetBirthplaceCountryVitalRecords.
Mortality Roster 31 Decedent's Residence Country - Code COUNTRYC address.country string ValueSetResidenceCountryVitalRecords
Mortality Roster 32 Decedent's SSN (may be used by some jurisdictions when allowed by law, to match with the SSN contained with the birth record) SSN identifier.value where system = 'http://hl7.org/fhir/sid/us-ssn and type.coding.code="SB" string -

Form Mapping

Form Mapping
Item # Form Field FHIR Profile Field Reference
1 Decedent's Legal Name name Certificate of Death
2 Sex extension:NVSS-SexAtDeath Certificate of Death
3 Social Security Number identifier:SSN Certificate of Death
5 Date of Birth birthDate Certificate of Death
6 Birthplace extension:birthPlace Certificate of Death
7a Residence-State address.state Certificate of Death
7b County address.district Certificate of Death
7c City or Town address.city Certificate of Death
7d Street and Number address.line Certificate of Death
7e Apt No address.extension:unitnumber Certificate of Death
7f Zip Code address.postalCode Certificate of Death
7g Inside City Limits? address.extension:withinCityLimitsIndicator Certificate of Death
9 Marital Status at Time of Death maritalStatus Certificate of Death
13a Informant's Name contact.name Certificate of Death
13b Informant's Relationship to Decedent contact.type.text Certificate of Death
13c Informant's Mailing Address contact.type.address Certificate of Death

Usage:

Changes since version true:

  • No changes

    • 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 PatientVitalRecords
    ... extension:birthPlace 0..1 birthPlace Decedent birthplace
    .... value[x]
    ..... state 0..1 string Sub-unit of country (abbreviations ok)
    Binding: ValueSet - States, Territories and Provinces Vital Records (required)
    ... NVSS-SexAtDeath 0..1 CodeableConcept NVSS Sex at Death
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
    Binding: Administrative Gender ValueSet (preferred)
    Additional BindingsPurpose
    Administrative Gender ValueSet - Max Max Binding
    ... Spouse-Alive 0..1 CodeableConcept Spouse Alive?
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
    Binding: Spouse Alive ValueSet (required)
    ... identifier:SB 0..1 Identifier **Deprecated** Decedent's Social Security Number for Compatibility. Use SSN.
    .... type 1..1 CodeableConcept Description of identifier
    Required Pattern: At least the following
    ..... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: SB
    ... birthDate 0..1 date Date of Birth
    ... Slices for deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not
    Slice: Unordered, Open by type:$this
    .... deceased[x]:deceasedBoolean 0..1 boolean Indicates if the individual is deceased or not
    Required Pattern: true
    ... address 0..* Address Decedent's Residence
    .... state 0..1 string State/Jurisdiction of residence. Provide both state and jurisdiction if different.
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... residenceJurisdictionId 0..1 string Extension
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr
    Binding: ValueSet - Jurisdictions Vital Records (required)
    ... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
    Binding: Marital Status Vital Records (required)
    .... bypassEditFlag 0..1 (Complex) Extension - BypassEditFlag Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Edit Bypass 0124 (required)
    .... text 0..1 string Marital Description
    ... contact 0..* BackboneElement Informant information
    .... relationship 0..1 CodeableConcept Informant Relationship (INFORMRELATE)
    ..... text 0..1 string Informant Relationship (INFORMRELATE) - first 30 characters will be used

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Patient.extension:birthPlace.value[x].staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
    Patient.maritalStatusrequiredValueSetMaritalStatusVitalRecords
    http://hl7.org/fhir/us/vrdr/ValueSet/ValueSet-marital-status-vr
    from this IG
    Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
    http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-edit-bypass-0124-vs
    from this IG
    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.
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... 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
    ... genderIdentity 0..1 CodeableConcept Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
    Binding: Gender Identity . (extensible)
    ... birthPlace 0..1 (Complex) Decedent birthplace
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    .... extension 0..0
    .... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
    .... value[x] 1..1 Address Value of extension
    ..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


    Example General: home
    ..... state Σ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: ValueSet - States, Territories and Provinces Vital Records (required)
    ... parentReportedAgeAtDelivery 0..2 (Complex) Extension - Reported Parent Age at Delivery - Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
    ... fetalDeath 0..1 Coding fetal-death
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
    ... NVSS-SexAtDeath 0..1 CodeableConcept NVSS Sex at Death
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
    Binding: Administrative Gender ValueSet (preferred)
    Additional BindingsPurpose
    Administrative Gender ValueSet - Max Max Binding

    ... Spouse-Alive 0..1 CodeableConcept Spouse Alive?
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
    Binding: Spouse Alive ValueSet (required)
    ... 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
    ..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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


    Required Pattern: At least the following
    ...... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ....... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: MR
    ..... system SΣ 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value SΣ 1..1 string The value that is unique within the system.
    Example General: 123456
    .... identifier:SSN SΣ 0..1 Identifier Decedent's Social Security 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: 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
    .... identifier:SB SΣ 0..1 Identifier **Deprecated** Decedent's Social Security Number for Compatibility. Use SSN.
    ..... 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: SB
    ... 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 ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    ..... family SΣC 1..1 string Family name (often called 'Surname')
    ...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
    URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
    Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


    ..... 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
    ...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
    URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
    Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


    .... 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Σ 0..1 date Date of Birth
    .... partialDateTime 0..1 (Complex) partialDateTIme
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
    .... birthTime 0..1 dateTime Time of day of birth
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    .... bypassEditFlag 0..1 (Complex) Extension - 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

    ... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
    Slice: Unordered, Open by type:$this
    .... deceasedBoolean boolean
    .... deceasedDateTime dateTime
    .... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Indicates if the individual is deceased or not
    Required Pattern: true
    ... address SΣ 0..* Address Decedent's Residence
    .... 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: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)


    .... predir 0..1 string Extension - PreDirectional Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
    .... stnum 0..1 string Extension - StreetNumber Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
    .... stname 0..1 string Extension - StreetName Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
    .... stdesig 0..1 string Extension - StreetDesignator Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
    .... postdir 0..1 string Extension - PostDirectional Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
    .... unitnumber 0..1 string Extension - 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
    ..... cityCode 0..1 positiveInt City Code
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
    .... state SΣ 0..1 string State/Jurisdiction of residence. Provide both state and jurisdiction if different.
    Binding: ValueSet - States, Territories and Provinces Vital Records (required)
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... residenceJurisdictionId 0..1 string Extension
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr
    Binding: ValueSet - Jurisdictions 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"}
    ... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
    Binding: Marital Status Vital Records (required)
    .... bypassEditFlag 0..1 (Complex) Extension - BypassEditFlag Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
    ..... extension 0..0
    ..... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Edit Bypass 0124 (required)
    .... text Σ 0..1 string Marital Description
    ... contact C 0..* BackboneElement Informant information
    pat-1: SHALL at least contain a contact's details or a reference to an organization
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... relationship 0..1 CodeableConcept Informant Relationship (INFORMRELATE)
    Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


    ..... text Σ 0..1 string Informant Relationship (INFORMRELATE) - first 30 characters will be used
    ... 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: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
    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.identifier:SB.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Patient.identifier:SB.typeextensiblePattern: SB
    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]requiredValueSetMothersDateOfBirthEditFlagsVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mothers-date-of-birth-edit-flags-vr
    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
    Patient.maritalStatusrequiredValueSetMaritalStatusVitalRecords
    http://hl7.org/fhir/us/vrdr/ValueSet/ValueSet-marital-status-vr
    from this IG
    Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
    http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-edit-bypass-0124-vs
    from this IG
    Patient.contact.relationshipextensiblePatientContactRelationship
    http://hl7.org/fhir/ValueSet/patient-contactrelationship
    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
    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.
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ... race 0..1 (Complex) US Core Race Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
    ... ethnicity 0..1 (Complex) US Core ethnicity Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
    ... birthsex 0..1 code Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
    Binding: Birth Sex (required): Code for sex assigned at birth


    ... genderIdentity 0..1 CodeableConcept Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
    Binding: Gender Identity . (extensible)
    ... birthPlace 0..1 (Complex) Decedent birthplace
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..0
    .... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
    .... value[x] 1..1 Address Value of extension
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


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


    Example General: both
    ..... text Σ 0..1 string Text representation of the address
    Example General: 137 Nowhere Street, Erewhon 9132
    ..... line Σ 0..* string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    ..... city Σ 0..1 string Name of city, town etc.
    Example General: Erewhon
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... cityCode 0..1 positiveInt Extension - City Code Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
    ...... value 0..1 string Primitive value for string
    Max Length: 1048576
    ..... district Σ 0..1 string District name (aka county)
    Example General: Madison
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... districtCode 0..1 positiveInt County code
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
    ...... value 0..1 string Primitive value for string
    Max Length: 1048576
    ..... state Σ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: ValueSet - States, Territories and Provinces Vital Records (required)
    ..... 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: ValueSet - Birthplace Country Vital Records (required)
    ..... period Σ 0..1 Period Time period when address was/is in use
    Example General: {"start":"2010-03-23","end":"2010-07-01"}
    ... parentReportedAgeAtDelivery 0..2 (Complex) Extension - Reported Parent Age at Delivery - Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
    ... fetalDeath 0..1 Coding fetal-death
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
    ... NVSS-SexAtDeath 0..1 CodeableConcept NVSS Sex at Death
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
    Binding: Administrative Gender ValueSet (preferred)
    Additional BindingsPurpose
    Administrative Gender ValueSet - Max Max Binding

    ... Spouse-Alive 0..1 CodeableConcept Spouse Alive?
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
    Binding: Spouse Alive ValueSet (required)
    ... 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
    ..... system SΣ 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value SΣ 1..1 string The value that is unique within the system.
    Example General: 123456
    ..... period Σ 0..1 Period Time period when id is/was valid for use
    ..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
    .... identifier:SSN SΣ 0..1 Identifier Decedent's Social Security 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: 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)
    .... identifier:SB SΣ 0..1 Identifier **Deprecated** Decedent's Social Security Number for Compatibility. Use SSN.
    ..... 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: SB
    ....... 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 Σ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value Σ 0..1 string The value that is unique
    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 ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    ..... text Σ 0..1 string Text representation of the full name
    ..... family SΣC 1..1 string Family name (often called 'Surname')
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
    URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
    Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


    ...... value 0..1 string Primitive value for string
    Max Length: 1048576
    ..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
    URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
    Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


    ...... value 0..1 string Primitive value for string
    Max Length: 1048576
    ..... prefix Σ 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    ..... suffix Σ 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    ..... period Σ 0..1 Period Time period when name was/is in use
    .... name:currentLegalName SΣ 0..1 HumanName current legal name
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.


    Fixed Value: official
    ..... text Σ 0..1 string Text representation of the full name
    ..... family SΣC 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Σ 0..1 date Date of Birth
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... partialDateTime 0..1 (Complex) partialDateTIme
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
    .... birthTime 0..1 dateTime Time of day of birth
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    .... bypassEditFlag 0..1 (Complex) Extension - 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

    .... value 0..1 date Primitive value for date
    ... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
    Slice: Unordered, Open by type:$this
    .... deceasedBoolean boolean
    .... deceasedDateTime dateTime
    .... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Indicates if the individual is deceased or not
    Required Pattern: true
    ... address SΣ 0..* Address Decedent's Residence
    .... 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: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)


    .... predir 0..1 string Extension - PreDirectional Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
    .... stnum 0..1 string Extension - StreetNumber Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
    .... stname 0..1 string Extension - StreetName Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
    .... stdesig 0..1 string Extension - StreetDesignator Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
    .... postdir 0..1 string Extension - PostDirectional Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
    .... unitnumber 0..1 string Extension - 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 State/Jurisdiction of residence. Provide both state and jurisdiction if different.
    Binding: ValueSet - 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
    ..... residenceJurisdictionId 0..1 string Extension
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr
    Binding: ValueSet - Jurisdictions Vital Records (required)
    ..... value 0..1 string Primitive value for string
    Max Length: 1048576
    .... 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: ValueSet - 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 Vital Records (required)
    .... 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) Extension - BypassEditFlag Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Edit Bypass 0124 (required)
    .... coding Σ 0..* Coding Code defined by a terminology system
    .... text Σ 0..1 string Marital Description
    ... multipleBirth[x] 0..1 If not single birth - born first, second, third, etc.
    .... multipleBirth[x]:All Types Content/Rules for all Types
    ..... id 0..1 string Unique id for inter-element referencing
    ..... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... bypassEditFlag 0..1 (Complex) Extension - BypassEditFlag Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..0
    ...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
    ...... value[x] 1..1 CodeableConcept Value of extension
    Binding: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

    ..... multipleBirthTotal 0..1 positiveInt Total births in this pregnancy
    URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
    .... multipleBirthBoolean boolean
    .... multipleBirthInteger integer
    ... photo 0..* Attachment Image of the patient
    ... contact C 0..* BackboneElement Informant information
    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..1 CodeableConcept Informant Relationship (INFORMRELATE)
    Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... coding Σ 0..* Coding Code defined by a terminology system
    ..... text Σ 0..1 string Informant Relationship (INFORMRELATE) - first 30 characters will be used
    .... 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: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
    Patient.extension:birthPlace.value[x].countryrequiredValueSetBirthplaceCountryVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr
    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.identifier:SB.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Patient.identifier:SB.typeextensiblePattern: SB
    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]requiredValueSetMothersDateOfBirthEditFlagsVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mothers-date-of-birth-edit-flags-vr
    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
    Patient.address.countryrequiredValueSetResidenceCountryVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
    Patient.maritalStatusrequiredValueSetMaritalStatusVitalRecords
    http://hl7.org/fhir/us/vrdr/ValueSet/ValueSet-marital-status-vr
    from this IG
    Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
    http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-edit-bypass-0124-vs
    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
    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

    This structure is derived from PatientVitalRecords

    Summary

    Mandatory: 0 element(1 nested mandatory element)

    Extensions

    This structure refers to these extensions:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Patient.deceased[x]

    Differential View

    This structure is derived from PatientVitalRecords

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient PatientVitalRecords
    ... extension:birthPlace 0..1 birthPlace Decedent birthplace
    .... value[x]
    ..... state 0..1 string Sub-unit of country (abbreviations ok)
    Binding: ValueSet - States, Territories and Provinces Vital Records (required)
    ... NVSS-SexAtDeath 0..1 CodeableConcept NVSS Sex at Death
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
    Binding: Administrative Gender ValueSet (preferred)
    Additional BindingsPurpose
    Administrative Gender ValueSet - Max Max Binding
    ... Spouse-Alive 0..1 CodeableConcept Spouse Alive?
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
    Binding: Spouse Alive ValueSet (required)
    ... identifier:SB 0..1 Identifier **Deprecated** Decedent's Social Security Number for Compatibility. Use SSN.
    .... type 1..1 CodeableConcept Description of identifier
    Required Pattern: At least the following
    ..... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: SB
    ... birthDate 0..1 date Date of Birth
    ... Slices for deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not
    Slice: Unordered, Open by type:$this
    .... deceased[x]:deceasedBoolean 0..1 boolean Indicates if the individual is deceased or not
    Required Pattern: true
    ... address 0..* Address Decedent's Residence
    .... state 0..1 string State/Jurisdiction of residence. Provide both state and jurisdiction if different.
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... residenceJurisdictionId 0..1 string Extension
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr
    Binding: ValueSet - Jurisdictions Vital Records (required)
    ... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
    Binding: Marital Status Vital Records (required)
    .... bypassEditFlag 0..1 (Complex) Extension - BypassEditFlag Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Edit Bypass 0124 (required)
    .... text 0..1 string Marital Description
    ... contact 0..* BackboneElement Informant information
    .... relationship 0..1 CodeableConcept Informant Relationship (INFORMRELATE)
    ..... text 0..1 string Informant Relationship (INFORMRELATE) - first 30 characters will be used

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Patient.extension:birthPlace.value[x].staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
    Patient.maritalStatusrequiredValueSetMaritalStatusVitalRecords
    http://hl7.org/fhir/us/vrdr/ValueSet/ValueSet-marital-status-vr
    from this IG
    Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
    http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-edit-bypass-0124-vs
    from this IG

    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.
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... 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
    ... genderIdentity 0..1 CodeableConcept Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
    Binding: Gender Identity . (extensible)
    ... birthPlace 0..1 (Complex) Decedent birthplace
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    .... extension 0..0
    .... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
    .... value[x] 1..1 Address Value of extension
    ..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


    Example General: home
    ..... state Σ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: ValueSet - States, Territories and Provinces Vital Records (required)
    ... parentReportedAgeAtDelivery 0..2 (Complex) Extension - Reported Parent Age at Delivery - Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
    ... fetalDeath 0..1 Coding fetal-death
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
    ... NVSS-SexAtDeath 0..1 CodeableConcept NVSS Sex at Death
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
    Binding: Administrative Gender ValueSet (preferred)
    Additional BindingsPurpose
    Administrative Gender ValueSet - Max Max Binding

    ... Spouse-Alive 0..1 CodeableConcept Spouse Alive?
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
    Binding: Spouse Alive ValueSet (required)
    ... 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
    ..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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


    Required Pattern: At least the following
    ...... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ....... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ....... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: MR
    ..... system SΣ 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value SΣ 1..1 string The value that is unique within the system.
    Example General: 123456
    .... identifier:SSN SΣ 0..1 Identifier Decedent's Social Security 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: 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
    .... identifier:SB SΣ 0..1 Identifier **Deprecated** Decedent's Social Security Number for Compatibility. Use SSN.
    ..... 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: SB
    ... 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 ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    ..... family SΣC 1..1 string Family name (often called 'Surname')
    ...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
    URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
    Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


    ..... 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
    ...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
    URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
    Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


    .... 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Σ 0..1 date Date of Birth
    .... partialDateTime 0..1 (Complex) partialDateTIme
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
    .... birthTime 0..1 dateTime Time of day of birth
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    .... bypassEditFlag 0..1 (Complex) Extension - 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

    ... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
    Slice: Unordered, Open by type:$this
    .... deceasedBoolean boolean
    .... deceasedDateTime dateTime
    .... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Indicates if the individual is deceased or not
    Required Pattern: true
    ... address SΣ 0..* Address Decedent's Residence
    .... 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: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)


    .... predir 0..1 string Extension - PreDirectional Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
    .... stnum 0..1 string Extension - StreetNumber Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
    .... stname 0..1 string Extension - StreetName Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
    .... stdesig 0..1 string Extension - StreetDesignator Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
    .... postdir 0..1 string Extension - PostDirectional Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
    .... unitnumber 0..1 string Extension - 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
    ..... cityCode 0..1 positiveInt City Code
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
    .... state SΣ 0..1 string State/Jurisdiction of residence. Provide both state and jurisdiction if different.
    Binding: ValueSet - States, Territories and Provinces Vital Records (required)
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ..... residenceJurisdictionId 0..1 string Extension
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr
    Binding: ValueSet - Jurisdictions 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"}
    ... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
    Binding: Marital Status Vital Records (required)
    .... bypassEditFlag 0..1 (Complex) Extension - BypassEditFlag Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
    ..... extension 0..0
    ..... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Edit Bypass 0124 (required)
    .... text Σ 0..1 string Marital Description
    ... contact C 0..* BackboneElement Informant information
    pat-1: SHALL at least contain a contact's details or a reference to an organization
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... relationship 0..1 CodeableConcept Informant Relationship (INFORMRELATE)
    Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


    ..... text Σ 0..1 string Informant Relationship (INFORMRELATE) - first 30 characters will be used
    ... 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: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
    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.identifier:SB.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Patient.identifier:SB.typeextensiblePattern: SB
    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]requiredValueSetMothersDateOfBirthEditFlagsVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mothers-date-of-birth-edit-flags-vr
    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
    Patient.maritalStatusrequiredValueSetMaritalStatusVitalRecords
    http://hl7.org/fhir/us/vrdr/ValueSet/ValueSet-marital-status-vr
    from this IG
    Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
    http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-edit-bypass-0124-vs
    from this IG
    Patient.contact.relationshipextensiblePatientContactRelationship
    http://hl7.org/fhir/ValueSet/patient-contactrelationship
    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

    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.
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ... race 0..1 (Complex) US Core Race Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
    ... ethnicity 0..1 (Complex) US Core ethnicity Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
    ... birthsex 0..1 code Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
    Binding: Birth Sex (required): Code for sex assigned at birth


    ... genderIdentity 0..1 CodeableConcept Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
    Binding: Gender Identity . (extensible)
    ... birthPlace 0..1 (Complex) Decedent birthplace
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..0
    .... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
    .... value[x] 1..1 Address Value of extension
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


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


    Example General: both
    ..... text Σ 0..1 string Text representation of the address
    Example General: 137 Nowhere Street, Erewhon 9132
    ..... line Σ 0..* string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    ..... city Σ 0..1 string Name of city, town etc.
    Example General: Erewhon
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... cityCode 0..1 positiveInt Extension - City Code Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
    ...... value 0..1 string Primitive value for string
    Max Length: 1048576
    ..... district Σ 0..1 string District name (aka county)
    Example General: Madison
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... districtCode 0..1 positiveInt County code
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
    ...... value 0..1 string Primitive value for string
    Max Length: 1048576
    ..... state Σ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: ValueSet - States, Territories and Provinces Vital Records (required)
    ..... 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: ValueSet - Birthplace Country Vital Records (required)
    ..... period Σ 0..1 Period Time period when address was/is in use
    Example General: {"start":"2010-03-23","end":"2010-07-01"}
    ... parentReportedAgeAtDelivery 0..2 (Complex) Extension - Reported Parent Age at Delivery - Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
    ... fetalDeath 0..1 Coding fetal-death
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
    ... NVSS-SexAtDeath 0..1 CodeableConcept NVSS Sex at Death
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
    Binding: Administrative Gender ValueSet (preferred)
    Additional BindingsPurpose
    Administrative Gender ValueSet - Max Max Binding

    ... Spouse-Alive 0..1 CodeableConcept Spouse Alive?
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
    Binding: Spouse Alive ValueSet (required)
    ... 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
    ..... system SΣ 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value SΣ 1..1 string The value that is unique within the system.
    Example General: 123456
    ..... period Σ 0..1 Period Time period when id is/was valid for use
    ..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
    .... identifier:SSN SΣ 0..1 Identifier Decedent's Social Security 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: 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)
    .... identifier:SB SΣ 0..1 Identifier **Deprecated** Decedent's Social Security Number for Compatibility. Use SSN.
    ..... 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: SB
    ....... 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 Σ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value Σ 0..1 string The value that is unique
    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 ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    ..... text Σ 0..1 string Text representation of the full name
    ..... family SΣC 1..1 string Family name (often called 'Surname')
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
    URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
    Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


    ...... value 0..1 string Primitive value for string
    Max Length: 1048576
    ..... given SΣC 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
    URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
    Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


    ...... value 0..1 string Primitive value for string
    Max Length: 1048576
    ..... prefix Σ 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    ..... suffix Σ 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    ..... period Σ 0..1 Period Time period when name was/is in use
    .... name:currentLegalName SΣ 0..1 HumanName current legal name
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.


    Fixed Value: official
    ..... text Σ 0..1 string Text representation of the full name
    ..... family SΣC 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Σ 0..1 date Date of Birth
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... partialDateTime 0..1 (Complex) partialDateTIme
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
    .... birthTime 0..1 dateTime Time of day of birth
    URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
    .... bypassEditFlag 0..1 (Complex) Extension - 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)

    .... value 0..1 date Primitive value for date
    ... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
    Slice: Unordered, Open by type:$this
    .... deceasedBoolean boolean
    .... deceasedDateTime dateTime
    .... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Indicates if the individual is deceased or not
    Required Pattern: true
    ... address SΣ 0..* Address Decedent's Residence
    .... 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: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)


    .... predir 0..1 string Extension - PreDirectional Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
    .... stnum 0..1 string Extension - StreetNumber Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
    .... stname 0..1 string Extension - StreetName Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
    .... stdesig 0..1 string Extension - StreetDesignator Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
    .... postdir 0..1 string Extension - PostDirectional Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
    .... unitnumber 0..1 string Extension - 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 State/Jurisdiction of residence. Provide both state and jurisdiction if different.
    Binding: ValueSet - 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
    ..... residenceJurisdictionId 0..1 string Extension
    URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr
    Binding: ValueSet - Jurisdictions Vital Records (required)
    ..... value 0..1 string Primitive value for string
    Max Length: 1048576
    .... 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: ValueSet - 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 Vital Records (required)
    .... 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) Extension - BypassEditFlag Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Edit Bypass 0124 (required)
    .... coding Σ 0..* Coding Code defined by a terminology system
    .... text Σ 0..1 string Marital Description
    ... multipleBirth[x] 0..1 If not single birth - born first, second, third, etc.
    .... multipleBirth[x]:All Types Content/Rules for all Types
    ..... id 0..1 string Unique id for inter-element referencing
    ..... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... bypassEditFlag 0..1 (Complex) Extension - BypassEditFlag Vital Records
    URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..0
    ...... url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
    ...... value[x] 1..1 CodeableConcept Value of extension
    Binding: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

    ..... multipleBirthTotal 0..1 positiveInt Total births in this pregnancy
    URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
    .... multipleBirthBoolean boolean
    .... multipleBirthInteger integer
    ... photo 0..* Attachment Image of the patient
    ... contact C 0..* BackboneElement Informant information
    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..1 CodeableConcept Informant Relationship (INFORMRELATE)
    Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... coding Σ 0..* Coding Code defined by a terminology system
    ..... text Σ 0..1 string Informant Relationship (INFORMRELATE) - first 30 characters will be used
    .... 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: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
    Patient.extension:birthPlace.value[x].countryrequiredValueSetBirthplaceCountryVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr
    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.identifier:SB.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Patient.identifier:SB.typeextensiblePattern: SB
    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]requiredValueSetMothersDateOfBirthEditFlagsVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mothers-date-of-birth-edit-flags-vr
    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
    Patient.address.countryrequiredValueSetResidenceCountryVitalRecords
    http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
    Patient.maritalStatusrequiredValueSetMaritalStatusVitalRecords
    http://hl7.org/fhir/us/vrdr/ValueSet/ValueSet-marital-status-vr
    from this IG
    Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
    http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-edit-bypass-0124-vs
    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
    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

    This structure is derived from PatientVitalRecords

    Summary

    Mandatory: 0 element(1 nested mandatory element)

    Extensions

    This structure refers to these extensions:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Patient.deceased[x]

     

    Other representations of profile: CSV, Excel, Schematron