This page is part of the Vital Records Common Profile Library (v1.1.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-mother-vr | Version: 1.1.0 | |||
Active as of 2023-10-06 | Computable Name: PatientMotherVitalRecords |
This Patient profile represents the woman who gave birth to, or delivered the infant.
This profile is mapped to:
Use Case | IJE Field# | Description | IJE Name | Field |
---|---|---|---|---|
Natality | 268 | Mother’s Residence Street Address | ADDRESS | address.line |
Natality | 19 | Birthplace of Mother–Country | BPLACEC_CNT | extension: patient-birthPlace |
Natality | 18 | State, U.S. Territory or Canadian Province of Birth (Mother) - code | BPLACEC_ST_TER | extension: patient-birthPlace |
Natality | 20 | Residence of Mother–City | CITYC | address.city |
Natality | 271 | Mother’s Residence City/Town (Literal) | CITYTEXT | address.city |
Natality | 273 | Mother’s Residence Country (Literal) | CNTRYTXT | address.country |
Natality | 23 | Residence of Mother–Country | COUNTRYC | address.country |
Natality | 21 | Residence of Mother–County | COUNTYC | address.district |
Natality | 270 | Mother’s Residence County (Literal) | COUNTYTXT | address.district |
Natality | 315 | Mother’s Mailing Address Street Address | MAIL_ADDRESS | address.line |
Natality | 318 | Mother’s Mailing Address City/Town (Literal) | MAIL_CITYTEXT | address.city |
Natality | 320 | Mother’s Mailing Address Country (Literal) | MAIL_CNTRYTXT | address.country |
Natality | 317 | Mother’s Mailing Address County (Literal) | MAIL_COUNTYTXT | address.district |
Natality | 313 | Mother’s Mailing Address Post Directional | MAIL_POSTDIR | address |
Natality | 310 | Mother’s Mailing Address Pre Directional | MAIL_PREDIR | address |
Natality | 319 | Mother’s Mailing Address State (Literal) | MAIL_STATETXT | address |
Natality | 312 | Mother’s Mailing Address Street designator | MAIL_STDESIG | address |
Natality | 311 | Mother’s Mailing Address Street name | MAIL_STNAME | address |
Natality | 309 | Mother’s Mailing Address Street number | MAIL_STNUM | address |
Natality | 314 | Mother’s Mailing Address Unit or Apartment Number | MAIL_UNUM | address |
Natality | 316 | Mother’s Mailing Address Zip Code and Zip+4 | MAIL_ZIPCODE | address |
Natality | 340 | For use of jurisdictions with domestic partnerships, othertypes of relationships. | MARITAL_DESCRIP | .maritalStatus |
Natality | 306 | Mother’s Country of Birth (Literal) | MBPLACE_CNTRY_TXT | extension:patient-birthPlace |
Natality | 305 | State, U.S. Territory or Canadian Province of Birth (Mother) - literal | MBPLACE_ST_TER_TXT | extension:patient-birthPlace |
Natality | 16 | Date of Birth (Mother)–Day | MDOB_DY | birthDate |
Natality | 15 | Date of Birth (Mother)–Month | MDOB_MO | birthDate |
Natality | 14 | Date of Birth (Mother)–Year | MDOB_YR | birthDate |
Natality | 34 | Mother of Hispanic Origin?–Mexican | METHNIC1 | extension:us-core-ethnicity |
Natality | 35 | Mother of Hispanic Origin?–Puerto Rican | METHNIC2 | extension:us-core-ethnicity |
Natality | 36 | Mother of Hispanic Origin?–Cuban | METHNIC3 | extension:us-core-ethnicity |
Natality | 37 | Mother of Hispanic Origin?–Other | METHNIC4 | extension:us-core-ethnicity |
Natality | 38 | Mother of Hispanic Origin?–Other Literal | METHNIC5 | extension:us-core-ethnicity |
Natality | 333 | Mother’s Medical Record Number | MOM_MED_REC_NUM | identifier |
Natality | 278 | Mother’s Social Security Number | MOM_SSN | identifier[type=SS] |
Natality | 258 | Mother’s First Maiden Name | MOMFMNME | name[use=maiden].given |
Natality | 254 | Mother’s First Name | MOMFNAME | name[use=official].given |
Natality | 256 | Mother’s Last Name | MOMLNAME | name[use=official].family |
Natality | 260 | Mother’s Maiden Surname | MOMMAIDN | name[use=maiden].family |
Natality | 255 | Mother’s Middle Name | MOMMIDDL | name[use=official].given |
Natality | 259 | Mother’s Middle Maiden Name | MOMMMID | name[use=maiden].given |
Natality | 261 | Mother’s Maiden Surname Suffix | MOMMSUFX | name[use=maiden].suffix |
Natality | 257 | Mother’s Surname Suffix | MOMSUFFX | name[use=official].suffix |
Natality | 39 | Mother’s Race–White | MRACE1 | extension:us-core-race |
Natality | 48 | Mother’s Race–Other Asian | MRACE10 | extension:us-core-race |
Natality | 49 | Mother’s Race–Native Hawaiian | MRACE11 | extension:us-core-race |
Natality | 50 | Mother’s Race–Guamanian or Chamorro | MRACE12 | extension:us-core-race |
Natality | 51 | Mother’s Race–Samoan | MRACE13 | extension:us-core-race |
Natality | 52 | Mother’s Race–Other Pacific Islander | MRACE14 | extension:us-core-race |
Natality | 53 | Mother’s Race–Other | MRACE15 | extension:us-core-race |
Natality | 54 | Mother’s Race–First American Indian or Alaska Native Literal | MRACE16 | extension:us-core-race |
Natality | 55 | Mother’s Race–Second American Indian or Alaska Native Literal | MRACE17 | extension:us-core-race |
Natality | 56 | Mother’s Race–First Other Asian Literal | MRACE18 | extension:us-core-race |
Natality | 57 | Mother’s Race–Second Other Asian Literal | MRACE19 | extension:us-core-race |
Natality | 40 | Mother’s Race–Black or African American | MRACE2 | extension:us-core-race |
Natality | 58 | Mother’s Race–First Other Pacific Islander Literal | MRACE20 | extension:us-core-race |
Natality | 59 | Mother’s Race–Second Other Pacific Islander Literal | MRACE21 | extension:us-core-race |
Natality | 60 | Mother’s Race–First Other Literal | MRACE22 | extension:us-core-race |
Natality | 61 | Mother’s Race–Second Other Literal | MRACE23 | extension:us-core-race |
Natality | 41 | Mother’s Race–American Indian or Alaska Native | MRACE3 | extension:us-core-race |
Natality | 42 | Mother’s Race–Asian Indian | MRACE4 | extension:us-core-race |
Natality | 43 | Mother’s Race–Chinese | MRACE5 | extension:us-core-race |
Natality | 44 | Mother’s Race–Filipino | MRACE6 | extension:us-core-race |
Natality | 45 | Mother’s Race–Japanese | MRACE7 | extension:us-core-race |
Natality | 46 | Mother’s Race–Korean | MRACE8 | extension:us-core-race |
Natality | 47 | Mother’s Race–Vietnamese | MRACE9 | extension:us-core-race |
Natality | 266 | Residence Post Directional | POSTDIR | address |
Natality | 263 | Residence Pre Directional | PREDIR | address |
Natality | 22 | State, U.S. Territory or Canadian Province of Residence (Mother) - code | STATEC | address.district |
Natality | 272 | State, U.S. Territory or Canadian Province of Residence (Mother) - literal | STATETXT | address |
Natality | 265 | Residence Street designator | STDESIG | address |
Natality | 264 | Residence Street name | STNAME | address |
Natality | 262 | Residence Street Number | STNUM | address |
Natality | 267 | Residence Unit or Apartment Number | UNUM | address |
Natality | 269 | Mother’s Residence Zip Code and Zip+4 | ZIPCODE | address |
Fetal Death | 253 | Mother’s Residence Street Address | ADDRESS | address.line |
Fetal Death | 252 | Mother’s Residence Unit or Apartment Number | APTNUMB | address.line |
Fetal Death | 19 | Mother’s Birthplace–Country | BPLACEC_CNT | extension: patient-birthPlace |
Fetal Death | 18 | State, U.S. Territory or Canadian Province of Birth (Mother) - code | BPLACEC_ST_TER | extension: patient-birthPlace |
Fetal Death | 20 | Residence of Mother–City/Town | CITYC | address.city |
Fetal Death | 256 | Mother’s Residence City/Town/Place (literal) | CITYTXT | address.city |
Fetal Death | 258 | Mother’s Residence Country (literal) | CNTRYTXT | address.country |
Fetal Death | 23 | Residence of Mother–Country | COUNTRYC | address.country |
Fetal Death | 21 | Residence of Mother–County | COUNTYC | address.district |
Fetal Death | 255 | Mother’s Residence County (literal) | COUNTYTXT | address.district |
Fetal Death | 280 | Mother’s Country of Birth (Literal) | MBPLACE_CNTRY_TXT | extension:patient-birthPlace |
Fetal Death | 279 | State, U.S. Territory or Canadian Province of Birth (Mother) - literal | MBPLACE_ST_TER_TXT | extension:patient-birthPlace |
Fetal Death | 16 | Date of Birth (Mother)–Day | MDOB_DY | birthDate |
Fetal Death | 15 | Date of Birth (Mother)–Month | MDOB_MO | birthDate |
Fetal Death | 14 | Date of Birth (Mother)–Year | MDOB_YR | birthDate |
Fetal Death | 34 | Mother of Hispanic Origin?–Mexican | METHNIC1 | extension:us-core-ethnicity |
Fetal Death | 35 | Mother of Hispanic Origin?–Puerto Rican | METHNIC2 | extension:us-core-ethnicity |
Fetal Death | 36 | Mother of Hispanic Origin?–Cuban | METHNIC3 | extension:us-core-ethnicity |
Fetal Death | 37 | Mother of Hispanic Origin?–Other | METHNIC4 | extension:us-core-ethnicity |
Fetal Death | 38 | Mother of Hispanic Origin?–Other Literal | METHNIC5 | extension:us-core-ethnicity |
Fetal Death | 265 | Mother’s Social Security Number | MOM_SSN | identifier[type=SS] |
Fetal Death | 243 | Mother’s First Maiden Name | MOMFMNME | name[use=maiden].given |
Fetal Death | 239 | Mother’s Legal First Name | MOMFNAME | name[use=official].given |
Fetal Death | 241 | Mother’s Legal Last Name | MOMLNAME | name[use=official].family |
Fetal Death | 245 | Mother’s Last Maiden Name | MOMMAIDN | name[use=maiden].family |
Fetal Death | 244 | Mother’s Middle Maiden Name | MOMMMID | name[use=maiden].given |
Fetal Death | 240 | Mother’s Legal Middle Name | MOMMNAME | name[use=official].given |
Fetal Death | 246 | Mother’s Maiden Surname Suffix | MOMMSUFFIX | name[use=maiden].suffix |
Fetal Death | 242 | Mother’s Legal Surname Suffix | MOMSUFFIX | name[use=official].suffix |
Fetal Death | 39 | Mother’s Race–White | MRACE1 | extension:us-core-race |
Fetal Death | 48 | Mother’s Race–Other Asian | MRACE10 | extension:us-core-race |
Fetal Death | 49 | Mother’s Race–Native Hawaiian | MRACE11 | extension:us-core-race |
Fetal Death | 50 | Mother’s Race–Guamanian or Chamorro | MRACE12 | extension:us-core-race |
Fetal Death | 51 | Mother’s Race–Samoan | MRACE13 | extension:us-core-race |
Fetal Death | 52 | Mother’s Race–Other Pacific Islander | MRACE14 | extension:us-core-race |
Fetal Death | 53 | Mother’s Race–Other | MRACE15 | extension:us-core-race |
Fetal Death | 54 | Mother’s Race–First American Indian or Alaska Native Literal | MRACE16 | extension:us-core-race |
Fetal Death | 55 | Mother’s Race–Second American Indian or Alaska Native Literal | MRACE17 | extension:us-core-race |
Fetal Death | 56 | Mother’s Race–First Other Asian Literal | MRACE18 | extension:us-core-race |
Fetal Death | 57 | Mother’s Race–Second Other Asian Literal | MRACE19 | extension:us-core-race |
Fetal Death | 40 | Mother’s Race–Black or African American | MRACE2 | extension:us-core-race |
Fetal Death | 58 | Mother’s Race–First Other Pacific Islander Literal | MRACE20 | extension:us-core-race |
Fetal Death | 59 | Mother’s Race–Second Other Pacific Islander Literal | MRACE21 | extension:us-core-race |
Fetal Death | 60 | Mother’s Race–First Other Literal | MRACE22 | extension:us-core-race |
Fetal Death | 61 | Mother’s Race–Second Other Literal | MRACE23 | extension:us-core-race |
Fetal Death | 41 | Mother’s Race–American Indian or Alaska Native | MRACE3 | extension:us-core-race |
Fetal Death | 42 | Mother’s Race–Asian Indian | MRACE4 | extension:us-core-race |
Fetal Death | 43 | Mother’s Race–Chinese | MRACE5 | extension:us-core-race |
Fetal Death | 44 | Mother’s Race–Filipino | MRACE6 | extension:us-core-race |
Fetal Death | 45 | Mother’s Race–Japanese | MRACE7 | extension:us-core-race |
Fetal Death | 46 | Mother’s Race–Korean | MRACE8 | extension:us-core-race |
Fetal Death | 47 | Mother’s Race–Vietnamese | MRACE9 | extension:us-core-race |
Fetal Death | 251 | Mother’s Residence Post Directional | POSTDIR | address |
Fetal Death | 248 | Mother’s Residence Pre Directional | PREDIR | address |
Fetal Death | 22 | State, U.S. Territory or Canadian Province of Residence (Mother) - code | STATEC | address.district |
Fetal Death | 257 | State, U.S. Territory or Canadian Province of Residence (Mother) - literal | STATETXT | address |
Fetal Death | 250 | Mother’s Residence Street designator | STDESIG | address |
Fetal Death | 249 | Mother’s Residence Street name | STNAME | address |
Fetal Death | 247 | Mother’s Residence Street number | STNUM | address |
Fetal Death | 254 | Mother’s Residence Zip code and Zip+4 | ZIPCODE | address |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePatientProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension:race | 1..1 | USCoreRaceExtension | If race is unknown, use UNK from the bound value set. | |
extension:ethnicity | 1..1 | USCoreEthnicityExtension | If ethnicity is unknown omit both coded data fields. | |
birthPlace | S | 0..1 | Address | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
Slices for identifier | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | |
identifier:MRN | S | 0..* | Identifier | Medical Record Number |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
identifier:SSN | S | 0..1 | Identifier | SSN if available and appropriate to send |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |
Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | |
name:All Slices | Content/Rules for all slices | |||
family | 1..1 | string | Family name (often called 'Surname') | |
name:currentLegalName | S | 0..1 | HumanName | Mother's current legal name |
use | S | 1..1 | code | Mother's name prior to first marriage Fixed Value: official |
name:namePriorToFirstMarriage | S | 0..1 | HumanName | A name associated with the patient |
use | S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden |
birthDate | 1..1 | date | The date of birth for the individual | |
partialDate | S | 0..* | (Complex) | Provides values of a partial date URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr |
deceased[x] | S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not, dateTime is preferred |
address | 0..* | Address | An address for the individual | |
withinCityLimitsIndicator | S | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: Yes No Unknown (YNU) (required): Yes No Unknown (YNU) |
Slices for link | S | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person Slice: Unordered, Open by pattern:type |
link:mother | S | 0..1 | BackboneElement | Link to the birth mother's RelatedPerson record |
other | S | 1..1 | Reference(RelatedPerson - Mother - Vital Records) | The other patient or related person resource that the link refers to |
type | S | 1..1 | code | replaced-by | replaces | refer | seealso Required Pattern: seealso |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
race | 1..1 | (Complex) | If race is unknown, use UNK from the bound value set. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
ethnicity | 1..1 | (Complex) | If ethnicity is unknown omit both coded data fields. 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 | S | 0..1 | Address | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type |
identifier:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:MRN | SΣ | 0..* | Identifier | Medical Record Number |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:SSN | SΣ | 0..1 | Identifier | SSN if available and appropriate to send |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 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 Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
name:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣC | 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:currentLegalName | SΣ | 0..1 | HumanName | Mother's current legal name |
use | ?!SΣ | 1..1 | code | Mother's name prior to first marriage Binding: NameUse (required): The use of a human name. Fixed Value: official |
family | SΣC | 0..1 | string | Family name (often called 'Surname') |
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
name:namePriorToFirstMarriage | SΣ | 0..1 | HumanName | A name associated with the patient |
use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden |
family | SΣC | 0..1 | string | Family name (often called 'Surname') |
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | SΣ | 1..1 | date | The date of birth for the individual |
partialDate | S | 0..* | (Complex) | Provides values of a partial date URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr |
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not, dateTime is preferred | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | SΣ | 0..* | Address | An address for the individual |
withinCityLimitsIndicator | S | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: Yes No Unknown (YNU) (required): Yes No Unknown (YNU) |
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 |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. |
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"} |
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) |
Slices for link | ?!SΣ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person Slice: Unordered, Open by pattern:type |
link:All Slices | Content/Rules for all slices | |||
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. |
link:mother | ?!SΣ | 0..1 | BackboneElement | Link to the birth mother's RelatedPerson record |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | SΣ | 1..1 | Reference(RelatedPerson - Mother - Vital Records) | The other patient or related person resource that the link refers to |
type | SΣ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Patient.identifier.use | required | IdentifierUse |
Patient.identifier:MRN.use | required | IdentifierUse |
Patient.identifier:MRN.type | extensible | Pattern: MR |
Patient.identifier:SSN.use | required | IdentifierUse |
Patient.identifier:SSN.type | extensible | Pattern: SS |
Patient.name.use | required | NameUse |
Patient.name:currentLegalName.use | required | Fixed Value: official |
Patient.name:namePriorToFirstMarriage.use | required | Fixed Value: maiden |
Patient.telecom.system | required | ContactPointSystem |
Patient.telecom.use | required | ContactPointUse |
Patient.gender | required | AdministrativeGender |
Patient.address.use | required | AddressUse |
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) |
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier |
Patient.link.type | required | LinkType |
Patient.link:mother.type | required | Pattern: seealso |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | Patient | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
race | 1..1 | (Complex) | If race is unknown, use UNK from the bound value set. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
ethnicity | 1..1 | (Complex) | If ethnicity is unknown omit both coded data fields. 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 | S | 0..1 | Address | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:MRN | SΣ | 0..* | Identifier | Medical Record Number | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:SSN | SΣ | 0..1 | Identifier | SSN if available and appropriate to send | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 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 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) | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
name:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣC | 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:currentLegalName | SΣ | 0..1 | HumanName | Mother's 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 | ?!SΣ | 1..1 | code | Mother's name prior to first marriage Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣC | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:namePriorToFirstMarriage | SΣ | 0..1 | HumanName | A name associated with the 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 | |||||
use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣC | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
birthDate | SΣ | 1..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
partialDate | S | 0..* | (Complex) | Provides values of a partial date URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr | ||||
value | 0..1 | date | Primitive value for date | |||||
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not, dateTime is preferred | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | SΣ | 0..* | Address | An address for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
withinCityLimitsIndicator | S | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: Yes No Unknown (YNU) (required): Yes No Unknown (YNU) | ||||
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 | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | ||||
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) | ||||
period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | ||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
Slices for link | ?!SΣ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person Slice: Unordered, Open by pattern:type | ||||
link: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 | |||||
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. | ||||
link:mother | ?!SΣ | 0..1 | BackboneElement | Link to the birth mother's RelatedPerson record | ||||
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 | SΣ | 1..1 | Reference(RelatedPerson - Mother - Vital Records) | The other patient or related person resource that the link refers to | ||||
type | SΣ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.identifier.use | required | IdentifierUse | ||||
Patient.identifier.type | extensible | Identifier Type Codes | ||||
Patient.identifier:MRN.use | required | IdentifierUse | ||||
Patient.identifier:MRN.type | extensible | Pattern: MR | ||||
Patient.identifier:SSN.use | required | IdentifierUse | ||||
Patient.identifier:SSN.type | extensible | Pattern: SS | ||||
Patient.name.use | required | NameUse | ||||
Patient.name:currentLegalName.use | required | Fixed Value: official | ||||
Patient.name:namePriorToFirstMarriage.use | required | Fixed Value: maiden | ||||
Patient.telecom.system | required | ContactPointSystem | ||||
Patient.telecom.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.address.use | required | AddressUse | ||||
Patient.address.type | required | AddressType | ||||
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier | ||||
Patient.link.type | required | LinkType | ||||
Patient.link:mother.type | required | Pattern: seealso |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
us-core-6 | error | Patient | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
This structure is derived from USCorePatientProfile
Summary
Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 16 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCorePatientProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension:race | 1..1 | USCoreRaceExtension | If race is unknown, use UNK from the bound value set. | |
extension:ethnicity | 1..1 | USCoreEthnicityExtension | If ethnicity is unknown omit both coded data fields. | |
birthPlace | S | 0..1 | Address | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
Slices for identifier | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | |
identifier:MRN | S | 0..* | Identifier | Medical Record Number |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
identifier:SSN | S | 0..1 | Identifier | SSN if available and appropriate to send |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |
Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | |
name:All Slices | Content/Rules for all slices | |||
family | 1..1 | string | Family name (often called 'Surname') | |
name:currentLegalName | S | 0..1 | HumanName | Mother's current legal name |
use | S | 1..1 | code | Mother's name prior to first marriage Fixed Value: official |
name:namePriorToFirstMarriage | S | 0..1 | HumanName | A name associated with the patient |
use | S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden |
birthDate | 1..1 | date | The date of birth for the individual | |
partialDate | S | 0..* | (Complex) | Provides values of a partial date URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr |
deceased[x] | S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not, dateTime is preferred |
address | 0..* | Address | An address for the individual | |
withinCityLimitsIndicator | S | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: Yes No Unknown (YNU) (required): Yes No Unknown (YNU) |
Slices for link | S | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person Slice: Unordered, Open by pattern:type |
link:mother | S | 0..1 | BackboneElement | Link to the birth mother's RelatedPerson record |
other | S | 1..1 | Reference(RelatedPerson - Mother - Vital Records) | The other patient or related person resource that the link refers to |
type | S | 1..1 | code | replaced-by | replaces | refer | seealso Required Pattern: seealso |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
race | 1..1 | (Complex) | If race is unknown, use UNK from the bound value set. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
ethnicity | 1..1 | (Complex) | If ethnicity is unknown omit both coded data fields. 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 | S | 0..1 | Address | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type |
identifier:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:MRN | SΣ | 0..* | Identifier | Medical Record Number |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
identifier:SSN | SΣ | 0..1 | Identifier | SSN if available and appropriate to send |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 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 Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
name:All Slices | Content/Rules for all slices | |||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣC | 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:currentLegalName | SΣ | 0..1 | HumanName | Mother's current legal name |
use | ?!SΣ | 1..1 | code | Mother's name prior to first marriage Binding: NameUse (required): The use of a human name. Fixed Value: official |
family | SΣC | 0..1 | string | Family name (often called 'Surname') |
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
name:namePriorToFirstMarriage | SΣ | 0..1 | HumanName | A name associated with the patient |
use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden |
family | SΣC | 0..1 | string | Family name (often called 'Surname') |
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | SΣ | 1..1 | date | The date of birth for the individual |
partialDate | S | 0..* | (Complex) | Provides values of a partial date URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr |
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not, dateTime is preferred | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | SΣ | 0..* | Address | An address for the individual |
withinCityLimitsIndicator | S | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: Yes No Unknown (YNU) (required): Yes No Unknown (YNU) |
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 |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. |
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"} |
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) |
Slices for link | ?!SΣ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person Slice: Unordered, Open by pattern:type |
link:All Slices | Content/Rules for all slices | |||
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. |
link:mother | ?!SΣ | 0..1 | BackboneElement | Link to the birth mother's RelatedPerson record |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | SΣ | 1..1 | Reference(RelatedPerson - Mother - Vital Records) | The other patient or related person resource that the link refers to |
type | SΣ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Patient.identifier.use | required | IdentifierUse |
Patient.identifier:MRN.use | required | IdentifierUse |
Patient.identifier:MRN.type | extensible | Pattern: MR |
Patient.identifier:SSN.use | required | IdentifierUse |
Patient.identifier:SSN.type | extensible | Pattern: SS |
Patient.name.use | required | NameUse |
Patient.name:currentLegalName.use | required | Fixed Value: official |
Patient.name:namePriorToFirstMarriage.use | required | Fixed Value: maiden |
Patient.telecom.system | required | ContactPointSystem |
Patient.telecom.use | required | ContactPointUse |
Patient.gender | required | AdministrativeGender |
Patient.address.use | required | AddressUse |
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) |
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier |
Patient.link.type | required | LinkType |
Patient.link:mother.type | required | Pattern: seealso |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | Patient | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
race | 1..1 | (Complex) | If race is unknown, use UNK from the bound value set. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
ethnicity | 1..1 | (Complex) | If ethnicity is unknown omit both coded data fields. 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 | S | 0..1 | Address | Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:MRN | SΣ | 0..* | Identifier | Medical Record Number | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:SSN | SΣ | 0..1 | Identifier | SSN if available and appropriate to send | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 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 | |||||