Vital Records Common Library (VRCL) STU2-ballot
2.0.0-ballot - ballot United States of America flag

This page is part of the Vital Records Common Profile Library (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Patient - Child Vital Records

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-child-vr Version: 2.0.0-ballot
Draft as of 2023-12-16 Computable Name: PatientChildVitalRecords

The subject patient (newborn/infant/child) for whom clinical data is included in the report.

This profile adds further constraints to the US Core Patient such as:

  • the patient-birthPlace extension
  • the patient-birthTime extension
  • the patient-multipleBirthTotal extension to record plurality
  • the base FHIR data-absent-reason extension to both name.given and name.family (a name may not yet have been chosen for the baby and US Core Patient requires that Patient.name.given or Patient.name.family or both SHALL be present)
    • use not-applicable if the name hasn’t been chosen

Profile conformance requires that gender be provided, see note on patient gender.

IJE Mapping

Natality
Use Case # Description IJE Name Field Type Value Set/Comments
Natality 1 Date of Birth (Infant)--Year IDOB_YR birthDate date See note on birth date and time
Natality 2 State, U.S. Territory or Canadian Province of Birth (Infant) - code BSTATE extension[patient-birthPlace].value[x].state string ValueSetJurisdictionVitalRecords
Natality 6 Time of Birth TB birthDate.extension[patient-birthTime] dateTime See note on birth date and time
Natality 7 Sex ISEX extension[birthsex].value codeable ValueSetBirthSexChildVitalRecords
Natality 8 Date of Birth (Infant)--Month IDOB_MO birthDate date See note on birth date and time
Natality 9 Date of Birth (Infant)--Day IDOB_DY birthDate date See note on birth date and time
Natality 10 County of Birth CNTYO extension[patient-birthPlace].value[x].district.extension[countyCode] integer See CountyCodes
Natality 207 Plurality PLUR extension[patient-multipleBirthTotal].valuePositiveInt integer
Natality 208 Set Order SORD multipleBirth[x] integer
Natality 211 Plurality--Edit Flag PLUR_BYPASS multipleBirth.extension[bypassEditFlag].value codeable PluralityEditFlagsVS,
See Handling of edit flags
Natality 237 Mother's Reported Age MAGER extension[parentReportedAgeAtDelivery].extension[reportedAge].value,
extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='MTH'		 quantity
Natality 238 Father's Reported Age FAGER extension[parentReportedAgeAtDelivery].extension[reportedAge].value,
extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='FTH'		 quantity
Natality 247 Child's First Name KIDFNAME name.given,
name.use = official		 string See note on Child and Decedent Fetus name
Natality 248 Child's Middle Name KIDMNAME name.given,
name.use = official 		string See note on Child and Decedent Fetus name
Natality 249 Child's Last Name KIDLNAME name.family,
name.use = official		 string See note on Child and Decedent Fetus name
Natality 250 Child's Surname Suffix (moved from end) KIDSUFFX name.suffix,
name.use = official		 string
Natality 251 County of Birth (Literal) BIRTH_CO extension[patient-birthPlace].value[x].district string
Natality 252 City/town/place of birth (Literal) BRTHCITY extension[patient-birthPlace].value[x].city string
Natality 332 Infant's Medical Record Number INF_MED_REC_NUM identifier.value where system = ‘http://terminology.hl7.org/CodeSystem/v2-0203'
and type.coding.code=”MR” 		string

Form Mapping

Item # Form Field FHIR Profile Field Reference
1 Child’s Name name Certificate of Live Birth
2 Child's Time of Birth extension Certificate of Live Birth
3 Child's Sex extension Certificate of Live Birth
4 Child's Date Of Birth birthDate Certificate of Live Birth
6 City, Town, Or Location Of Birth extension Certificate of Live Birth
7 County Of Birth extension Certificate of Live Birth
24 Father of Hispanic Origin? extension Certificate of Live Birth
25 Father’s Race extension Certificate of Live Birth
48 Newborn Medical Record Number identifier:MRN Certificate of Live Birth
52 Plurality multipleBirth[x].extension Certificate of Live Birth
53 If Not Single Birth - Born First, Second, Third, etc. (Specify) multipleBirthInteger Certificate of Live Birth
3 City, Town or Location of birth extension Facility Worksheet for the Live Birth Certificate
4 County of birth extension Facility Worksheet for the Live Birth Certificate
17 Date of birth birthDate Facility Worksheet for the Live Birth Certificate
18 Time of birth birthDate.extension Facility Worksheet for the Live Birth Certificate
22 Infant’s medical record number identifier:MRN Facility Worksheet for the Live Birth Certificate
31 Sex: extension Facility Worksheet for the Live Birth Certificate
33 Plurality multipleBirthInteger.extension Facility Worksheet for the Live Birth Certificate
34 If not single birth, order delivered in the pregnancy multipleBirthInteger Facility Worksheet for the Live Birth Certificate
- Child’s name/medical record # identifier Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
17 Date of birth birthDate Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
18 Time of birth birthDate.extension Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
34 Order delivered in the pregnancy multipleBirthInteger Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
31 Sex extension Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
2 What will be your baby’s legal name? name Mothers Worksheet for Child’s Birth Certificate

Usage:

Formal Views of Profile Content

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

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientVitalRecordsInformation about an individual or animal receiving health care services
... extension 1..*ExtensionExtension
... extension:race S0..1USCoreRaceExtensionUS Core Race Extension
... extension:ethnicity S0..1USCoreEthnicityExtensionUS Core ethnicity Extension
.... extension 0..0
.... value[x] 1..1codeValue of extension
Binding: ValueSet - Birth Sex Child Vital Records (required)
... extension:birthPlace S0..1birthPlacePlace of Birth for patient
... extension:parentReportedAgeAtDelivery 0..2ExtensionReportedParentAgeAtDeliveryVitalRecordsThe mother or father's reported age at the time of delivery of the child
... identifier:MRN S0..*IdentifierMedical Record Number
... name 1..*HumanNameA name associated with the patient
.... family
..... extension:dataAbsentReason 0..1Data Absent ReasonWhen "name not chosen" use code "temp-unknown"
.... given
..... extension:dataAbsentReason 0..1Data Absent ReasonWhen "name not chosen" use code "temp-unknown"
... birthDate 1..1dateBirth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... extension:partialDateTime S0..1ExtensionPartialDateTimeVitalRecordsUse if only partial date and time of birth is known
.... extension:birthTime S0..1birthTimeTime of Birth
... deceased[x] S0..1boolean, dateTimeIndicates if the individual is deceased or not, dateTime is preferred
... multipleBirth[x] S0..1integerIf not single birth - born first, second, third, etc.
.... extension:bypassEditFlag 0..1ExtensionBypassEditFlagVitalRecordsExtension - BypassEditFlag Vital Records
..... value[x] 1..1CodeableConceptTo reflect the relevant edit possibilities for plurality.
.... extension:multipleBirthTotal S0..1PatMultipleBirthTotalWhere a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.extension:birthsex.value[x]requiredValueSetBirthSexChildVitalRecords
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*PatientVitalRecordsInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... birthsex S1..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
.... value[x] 1..1codeValue of extension
Binding: ValueSet - Birth Sex Child Vital Records (required)
... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressValue of extension
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... parentReportedAgeAtDelivery 0..2(Complex)The mother or father's reported age at the time of delivery of the child
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
... fetalDeath 0..1Codingfetal-death
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:MRN SΣ0..*IdentifierMedical Record Number
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
.... identifier:SSN SΣ0..1IdentifierSSN if available and appropriate to send
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SS
..... system SΣ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name SΣ1..*HumanNameA name associated with the patient
Slice: Unordered, Open by value:use
.... name:All Slices Content/Rules for all slices
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... family SΣC1..1stringFamily name (often called 'Surname')
...... dataAbsentReason 0..1codeWhen "name not chosen" use code "temp-unknown"
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ΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... dataAbsentReason 0..1codeWhen "name not chosen" use code "temp-unknown"
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..1HumanNamecurrent legal name
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family SΣC1..1stringFamily name (often called 'Surname')
..... given SΣC0..*stringGiven 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..1HumanNameName prior to first marriage
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


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

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ1..1dateBirth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... partialDateTime S0..1(Complex)Use if only partial date and time of birth is known
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
.... birthTime S0..1dateTimeTime of Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... bypassEditFlag 0..1CodeableConceptExtension - BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptTo 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)

... deceased[x] ?!SΣ0..1Indicates if the individual is deceased or not, dateTime is preferred
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressAn address for the individual
.... withinCityLimitsIndicator 0..1CodingUsed 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..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... multipleBirth[x] S0..1integerIf not single birth - born first, second, third, etc.
.... bypassEditFlag 0..1CodeableConceptExtension - BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptTo reflect the relevant edit possibilities for plurality.
Binding: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

.... multipleBirthTotal S0..1positiveIntWhere a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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 / Code
Patient.extension:birthsex.value[x]requiredValueSetBirthSexChildVitalRecords
Patient.extension:birthPlace.value[x].userequiredAddressUse
Patient.identifier:MRN.userequiredIdentifierUse
Patient.identifier:MRN.typeextensiblePattern: MR
Patient.identifier:SSN.userequiredIdentifierUse
Patient.identifier:SSN.typeextensiblePattern: SS
Patient.name.userequiredNameUse
Patient.name:currentLegalName.userequiredFixed Value: official
Patient.name:namePriorToFirstMarriage.userequiredFixed Value: maiden
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.birthDate.extension:bypassEditFlag.value[x]requiredValueSetMothersDateOfBirthEditFlagsVitalRecords
Patient.address.userequiredAddressUse
Patient.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]requiredValueSetPluralityEditFlagsVitalRecords
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*PatientVitalRecordsInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

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


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
.... value[x] 1..1codeValue of extension
Binding: ValueSet - Birth Sex Child Vital Records (required)
... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressValue of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... cityCode 0..1positiveIntExtension - City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - Jurisdictions Vital Records (required)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Birthplace Country Vital Records (required)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... parentReportedAgeAtDelivery 0..2(Complex)The mother or father's reported age at the time of delivery of the child
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
... fetalDeath 0..1Codingfetal-death
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:MRN SΣ0..*IdentifierMedical Record Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:SSN SΣ0..1IdentifierSSN if available and appropriate to send
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SS
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name SΣ1..*HumanNameA name associated with the patient
Slice: Unordered, Open by value:use
.... name:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ0..1stringText representation of the full name
..... family SΣC1..1stringFamily name (often called 'Surname')
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1codeWhen "name not chosen" use code "temp-unknown"
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..1stringPrimitive value for string
Max Length: 1048576
..... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1codeWhen "name not chosen" use code "temp-unknown"
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..1stringPrimitive value for string
Max Length: 1048576
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... name:currentLegalName SΣ0..1HumanNamecurrent legal name
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ0..1stringText representation of the full name
..... family SΣC1..1stringFamily name (often called 'Surname')
..... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... name:namePriorToFirstMarriage SΣ0..1HumanNameName prior to first marriage
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: maiden
..... text Σ0..1stringText representation of the full name
..... family SΣC1..1stringFamily name (often called 'Surname')
..... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ1..1dateBirth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... partialDateTime S0..1(Complex)Use if only partial date and time of birth is known
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
.... birthTime S0..1dateTimeTime of Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... bypassEditFlag 0..1CodeableConceptExtension - BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptTo 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..1datePrimitive value for date
... deceased[x] ?!SΣ0..1Indicates if the individual is deceased or not, dateTime is preferred
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... withinCityLimitsIndicator 0..1CodingUsed 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..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Residence Country Vital Records (required)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] S0..1integerIf not single birth - born first, second, third, etc.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... bypassEditFlag 0..1CodeableConceptExtension - BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptTo reflect the relevant edit possibilities for plurality.
Binding: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

.... multipleBirthTotal S0..1positiveIntWhere a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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 / Code
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:birthsex.value[x]requiredValueSetBirthSexChildVitalRecords
Patient.extension:birthPlace.value[x].userequiredAddressUse
Patient.extension:birthPlace.value[x].typerequiredAddressType
Patient.extension:birthPlace.value[x].staterequiredValueSetJurisdictionVitalRecords
Patient.extension:birthPlace.value[x].countryrequiredValueSetBirthplaceCountryVitalRecords (a valid code from CodeSystem - Country Codes Vital Records)
Patient.identifier:MRN.userequiredIdentifierUse
Patient.identifier:MRN.typeextensiblePattern: MR
Patient.identifier:SSN.userequiredIdentifierUse
Patient.identifier:SSN.typeextensiblePattern: SS
Patient.name.userequiredNameUse
Patient.name:currentLegalName.userequiredFixed Value: official
Patient.name:namePriorToFirstMarriage.userequiredFixed Value: maiden
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.birthDate.extension:bypassEditFlag.value[x]requiredValueSetMothersDateOfBirthEditFlagsVitalRecords
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Patient.address.countryrequiredValueSetResidenceCountryVitalRecords
Patient.maritalStatusextensibleMarital Status Codes
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]requiredValueSetPluralityEditFlagsVitalRecords
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

This structure is derived from PatientVitalRecords

Summary

Mandatory: 3 elements
Must-Support: 10 elements
Prohibited: 1 element

Differential View

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientVitalRecordsInformation about an individual or animal receiving health care services
... extension 1..*ExtensionExtension
... extension:race S0..1USCoreRaceExtensionUS Core Race Extension
... extension:ethnicity S0..1USCoreEthnicityExtensionUS Core ethnicity Extension
.... extension 0..0
.... value[x] 1..1codeValue of extension
Binding: ValueSet - Birth Sex Child Vital Records (required)
... extension:birthPlace S0..1birthPlacePlace of Birth for patient
... extension:parentReportedAgeAtDelivery 0..2ExtensionReportedParentAgeAtDeliveryVitalRecordsThe mother or father's reported age at the time of delivery of the child
... identifier:MRN S0..*IdentifierMedical Record Number
... name 1..*HumanNameA name associated with the patient
.... family
..... extension:dataAbsentReason 0..1Data Absent ReasonWhen "name not chosen" use code "temp-unknown"
.... given
..... extension:dataAbsentReason 0..1Data Absent ReasonWhen "name not chosen" use code "temp-unknown"
... birthDate 1..1dateBirth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... extension:partialDateTime S0..1ExtensionPartialDateTimeVitalRecordsUse if only partial date and time of birth is known
.... extension:birthTime S0..1birthTimeTime of Birth
... deceased[x] S0..1boolean, dateTimeIndicates if the individual is deceased or not, dateTime is preferred
... multipleBirth[x] S0..1integerIf not single birth - born first, second, third, etc.
.... extension:bypassEditFlag 0..1ExtensionBypassEditFlagVitalRecordsExtension - BypassEditFlag Vital Records
..... value[x] 1..1CodeableConceptTo reflect the relevant edit possibilities for plurality.
.... extension:multipleBirthTotal S0..1PatMultipleBirthTotalWhere a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.extension:birthsex.value[x]requiredValueSetBirthSexChildVitalRecords

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*PatientVitalRecordsInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... birthsex S1..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
.... value[x] 1..1codeValue of extension
Binding: ValueSet - Birth Sex Child Vital Records (required)
... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressValue of extension
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... parentReportedAgeAtDelivery 0..2(Complex)The mother or father's reported age at the time of delivery of the child
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
... fetalDeath 0..1Codingfetal-death
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:MRN SΣ0..*IdentifierMedical Record Number
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
.... identifier:SSN SΣ0..1IdentifierSSN if available and appropriate to send
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SS
..... system SΣ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name SΣ1..*HumanNameA name associated with the patient
Slice: Unordered, Open by value:use
.... name:All Slices Content/Rules for all slices
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... family SΣC1..1stringFamily name (often called 'Surname')
...... dataAbsentReason 0..1codeWhen "name not chosen" use code "temp-unknown"
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ΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... dataAbsentReason 0..1codeWhen "name not chosen" use code "temp-unknown"
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..1HumanNamecurrent legal name
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family SΣC1..1stringFamily name (often called 'Surname')
..... given SΣC0..*stringGiven 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..1HumanNameName prior to first marriage
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


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

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ1..1dateBirth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... partialDateTime S0..1(Complex)Use if only partial date and time of birth is known
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
.... birthTime S0..1dateTimeTime of Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... bypassEditFlag 0..1CodeableConceptExtension - BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptTo 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)

... deceased[x] ?!SΣ0..1Indicates if the individual is deceased or not, dateTime is preferred
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressAn address for the individual
.... withinCityLimitsIndicator 0..1CodingUsed 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..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... multipleBirth[x] S0..1integerIf not single birth - born first, second, third, etc.
.... bypassEditFlag 0..1CodeableConceptExtension - BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptTo reflect the relevant edit possibilities for plurality.
Binding: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

.... multipleBirthTotal S0..1positiveIntWhere a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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 / Code
Patient.extension:birthsex.value[x]requiredValueSetBirthSexChildVitalRecords
Patient.extension:birthPlace.value[x].userequiredAddressUse
Patient.identifier:MRN.userequiredIdentifierUse
Patient.identifier:MRN.typeextensiblePattern: MR
Patient.identifier:SSN.userequiredIdentifierUse
Patient.identifier:SSN.typeextensiblePattern: SS
Patient.name.userequiredNameUse
Patient.name:currentLegalName.userequiredFixed Value: official
Patient.name:namePriorToFirstMarriage.userequiredFixed Value: maiden
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.birthDate.extension:bypassEditFlag.value[x]requiredValueSetMothersDateOfBirthEditFlagsVitalRecords
Patient.address.userequiredAddressUse
Patient.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]requiredValueSetPluralityEditFlagsVitalRecords
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*PatientVitalRecordsInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

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


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
.... value[x] 1..1codeValue of extension
Binding: ValueSet - Birth Sex Child Vital Records (required)
... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressValue of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... cityCode 0..1positiveIntExtension - City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - Jurisdictions Vital Records (required)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Birthplace Country Vital Records (required)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... parentReportedAgeAtDelivery 0..2(Complex)The mother or father's reported age at the time of delivery of the child
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
... fetalDeath 0..1Codingfetal-death
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:MRN SΣ0..*IdentifierMedical Record Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: MR
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:SSN SΣ0..1IdentifierSSN if available and appropriate to send
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SS
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name SΣ1..*HumanNameA name associated with the patient
Slice: Unordered, Open by value:use
.... name:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ0..1stringText representation of the full name
..... family SΣC1..1stringFamily name (often called 'Surname')
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1codeWhen "name not chosen" use code "temp-unknown"
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..1stringPrimitive value for string
Max Length: 1048576
..... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1codeWhen "name not chosen" use code "temp-unknown"
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..1stringPrimitive value for string
Max Length: 1048576
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... name:currentLegalName SΣ0..1HumanNamecurrent legal name
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ0..1stringText representation of the full name
..... family SΣC1..1stringFamily name (often called 'Surname')
..... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... name:namePriorToFirstMarriage SΣ0..1HumanNameName prior to first marriage
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: maiden
..... text Σ0..1stringText representation of the full name
..... family SΣC1..1stringFamily name (often called 'Surname')
..... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ1..1dateBirth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... partialDateTime S0..1(Complex)Use if only partial date and time of birth is known
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
.... birthTime S0..1dateTimeTime of Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... bypassEditFlag 0..1CodeableConceptExtension - BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptTo 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..1datePrimitive value for date
... deceased[x] ?!SΣ0..1Indicates if the individual is deceased or not, dateTime is preferred
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... withinCityLimitsIndicator 0..1CodingUsed 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..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Residence Country Vital Records (required)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] S0..1integerIf not single birth - born first, second, third, etc.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... bypassEditFlag 0..1CodeableConceptExtension - BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptTo reflect the relevant edit possibilities for plurality.
Binding: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)

.... multipleBirthTotal S0..1positiveIntWhere a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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 / Code
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:birthsex.value[x]requiredValueSetBirthSexChildVitalRecords
Patient.extension:birthPlace.value[x].userequiredAddressUse
Patient.extension:birthPlace.value[x].typerequiredAddressType
Patient.extension:birthPlace.value[x].staterequiredValueSetJurisdictionVitalRecords
Patient.extension:birthPlace.value[x].countryrequiredValueSetBirthplaceCountryVitalRecords (a valid code from CodeSystem - Country Codes Vital Records)
Patient.identifier:MRN.userequiredIdentifierUse
Patient.identifier:MRN.typeextensiblePattern: MR
Patient.identifier:SSN.userequiredIdentifierUse
Patient.identifier:SSN.typeextensiblePattern: SS
Patient.name.userequiredNameUse
Patient.name:currentLegalName.userequiredFixed Value: official
Patient.name:namePriorToFirstMarriage.userequiredFixed Value: maiden
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.birthDate.extension:bypassEditFlag.value[x]requiredValueSetMothersDateOfBirthEditFlagsVitalRecords
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Patient.address.countryrequiredValueSetResidenceCountryVitalRecords
Patient.maritalStatusextensibleMarital Status Codes
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]requiredValueSetPluralityEditFlagsVitalRecords
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

This structure is derived from PatientVitalRecords

Summary

Mandatory: 3 elements
Must-Support: 10 elements
Prohibited: 1 element

 

Other representations of profile: CSV, Excel, Schematron