Vital Records Death Reporting (VRDR) FHIR Implementation Guide
0.0.0-current - ci-build
Vital Records Death Reporting (VRDR) FHIR Implementation Guide
0.0.0-current - ci-build
Vital Records Death Reporting (VRDR) FHIR Implementation Guide, published by IHE Quality, Research and Public Health Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/QRPH.VRDR/ and changes regularly. See the Directory of published versions
| Official URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/vrdr-decedent | Version: 0.0.0-current | |||
| Active as of 2024-03-11 | Computable Name: Decedent | |||
Decedent
The Decedent profile contains basic information about the decedent, including data that are essential to the death record.
Note: The Decedent profile is based on the US Core Patient Profile which requires gender. The death record submission use case uses NCHS’s definition of sex at time of death which is different than gender. Complete death record submissions may fail FHIR validation due to lack of a value for gender.
| # | Description | IJE Name | IJE only | Field | Type | Value Set |
|---|---|---|---|---|---|---|
| 7 | Decedent’s Legal Name–Given | GNAME | name.given , name.use = official | string | See Note on Decedent Name | |
| 8 | Decedent’s Legal Name–Middle | MNAME | name.given , name.use = official (first letter) | string | See Note on Decedent Name | |
| 9 | Decedent’s Legal Name–Last | LNAME | name.family , name.use = official. (absence is equivalent to ‘UNKNOWN’.) | string | See Note on Decedent Name | |
| 10 | Decedent’s Legal Name–Suffix | SUFF | name.suffix , name.use = official | string | - | |
| NA | Gender | NO IJE MAPPING | gender | codeable | AdministrativeGenderVS - See Note on Decedent Gender | |
| 13 | Sex | SEX | extension[NVSS-SexAtDeath] | codeable | AdministrativeGenderVS | |
| 15 | Social Security Number | SSN | identifier.value where system = ‘http://hl7.org/fhir/sid/us-ssn and type.coding.code=”SB” | string | - | |
| 19 | Date of Birth–Year | DOB_YR | birthDate | dateTime | See PartialDatesAndTimes | |
| 20 | Date of Birth–Month | DOB_MO | birthDate | dateTime | See PartialDatesAndTimes | |
| 21 | Date of Birth–Day | DOB_DY | birthDate | dateTime | See PartialDatesAndTimes | |
| 22 | Birthplace–Country | BPLACE_CNT | extension[patient-birthPlace].value[x].country | string | BirthplaceCountryVS | |
| 23 | State, U.S. Territory or Canadian Province of Birth - code | BPLACE_ST | extension[patient-birthPlace].value[x].state | string | StatesTerritoriesProvincesVS | |
| 24 | Decedent’s Residence–City | CITYC | address.city.extension[ cityCode ] | integer | see CityCodes | |
| 25 | Decedent’s Residence–County | COUNTYC | address.district.extension[ districtCode ] | integer | see CountyCodes | |
| 26 | State, U.S. Territory or Canadian Province of Decedent’s residence - code | STATEC | address.state | string | StatesTerritoriesProvincesVS | |
| 27 | Decedent’s Residence–Country | COUNTRYC | address.country | string | ResidenceCountryVS | |
| 28 | Decedent’s Residence–Inside City Limits | LIMITS | address.city.extension[ withinCityLimits] | codeable | YesNoUnknownVS | |
| 29 | Marital Status | MARITAL | maritalStatus | codeable | MaritalStatusVS | |
| 30 | Marital Status–Edit Flag | MARITAL_BYPASS | maritalStatus.extension[ BypassEditFlag] | codeable | EditBypass0124VS | |
| 143 | Decedent’s spouse living at decedent’s DOD? | SPOUSELV | x | extension[ SpouseAlive] | codeable | SpouseAliveVS |
| 146 | Decedent’s Residence - Street number | STNUM_R | address.extension[stnum] | string | - | |
| 147 | Decedent’s Residence - Pre Directional | PREDIR_R | address.extension[predir] | string | - | |
| 148 | Decedent’s Residence - Street name | STNAME_R | address.extension[stname] | string | - | |
| 149 | Decedent’s Residence - Street designator | STDESIG_R | address.extension[stdesig] | string | - | |
| 150 | Decedent’s Residence - Post Directional | POSTDIR_R | address.extension[postdir] | string | - | |
| 151 | Decedent’s Residence - Unit or apt number | UNITNUM_R | address.extension[unitnum] | string | - | |
| 152 | Decedent’s Residence - City or Town name | CITYTEXT_R | address.city | string | - | |
| 153 | Decedent’s Residence - ZIP code | ZIP9_R | address.postalCode | string | - | |
| 154 | Decedent’s Residence - County | COUNTYTEXT_R | address.district | string | - | |
| 155 | Decedent’s Residence - State name | STATETEXT_R | address.state (expanded from 2 letter code) | string | See StateLiterals | |
| 156 | Decedent’s Residence - COUNTRY name | COUNTRYTEXT_R | address.country (expanded from 2 letter code) | string | See CountryLiterals | |
| 157 | Long string address for decedent’s place of residence same as above but allows states to choose the way they capture information. | ADDRESS_R | address.line[0] | string | - | |
| 166 | Middle Name of Decedent | DMIDDLE | x | name.given , name.use = official | string | - |
| 194 | Decedent’s Maiden Name | DMAIDEN | x | name.text , name.use=maiden | string | - |
| 195 | Decedent’s Birth Place City - Code | DBPLACECITYCODE | x | extension[patient-birthPlace].value[x].city.extension[ cityCode] | integer | see CityCodes |
| 196 | Decedent’s Birth Place City - Literal | DBPLACECITY | x | extension[patient-birthPlace].value[x].city | string | - |
| 201 | Informant’s Relationship | INFORMRELATE | x | contact.type.text | string (30 characters) | - |
| 238 | State, U.S. Territory or Canadian Province of Birth - literal | STATEBTH | x | extension[patient-birthPlace].value[x].state or extension[patient-birthPlace].value[x].state.extension[ nationalReportingJurisdictionId] if present (expanded from 2 letter code) | string | See StateLiterals |
| 246 | Marital Descriptor | MARITAL_DESCRIP | x | maritalStatus.text | string | - |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | Patient | |||
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 NVSS-SexAtDeath | 0..1 | CodeableConcept | NVSS Sex at Death URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender PHVS_Sex_MFU (required) | |
| Spouse-Alive | 0..1 | CodeableConcept | Spouse Alive? URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/SpouseAlive Binding: Spouse Alive Value Set (required) | |
| Patient-BirthPlace | 0..1 | Address | Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
   value[x] | ||||
 city | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 cityCode | 0..1 | positiveInt | City Code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/CityCode | |
| state | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) | |
| country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Birthplace Country Value Set (required) | |
 Slices for identifier | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system | |
 identifier:ni | 0..1 | Identifier | National Identifier | |
| type | 0..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: NI | |
| name | 1..* | HumanName | A name associated with the patient | |
| birthDate | 0..1 | date | Date of Birth | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| partialDate | 0..1 | (Complex) | partialDate URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PartialDate | |
| address | 0..* | Address | Decedent's Residence | |
| withinCityLimitsIndicator | 0..1 | Coding | Within City Limits Indicator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/WithinCityLimitsIndicator Binding: Yes No Unknown (required): Yes No Unknown | |
| predir | 0..1 | string | PreDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PreDirectional | |
| stnum | 0..1 | string | StreetNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetNumber | |
| stname | 0..1 | string | StreetName URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetName | |
| stdesig | 0..1 | string | StreetDesignator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetDesignator | |
| postdir | 0..1 | string | PostDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PostDirectional | |
| unitnumber | 0..1 | string | UnitOrAptNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/UnitOrAptNumber | |
| city | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cityCode | 0..1 | positiveInt | City Code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/CityCode | |
| district | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| districtCode | 0..1 | positiveInt | County code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/DistrictCode | |
| state | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (example) | |
| country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) | |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Value Set (required) | |
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 0124 (required) | |
| text | 0..1 | string | Marital Description | |
| contact | 0..* | BackboneElement | Informant information | |
| relationship | 0..1 | CodeableConcept | Informant Relationship (INFORMRELATE) | |
| text | 0..1 | string | Informant Relationship (INFORMRELATE) - first 30 characters will be used | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient.extension:Patient-BirthPlace.value[x].state | required | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | |
| Patient.extension:Patient-BirthPlace.value[x].country | required | BirthplaceCountryVS (a valid code from Country Codes)http://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-birthplace-country-vsfrom this IG | |
| Patient.address.state | example | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | |
| Patient.address.country | required | ResidenceCountryVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-residence-country-vsfrom this IG | |
| Patient.maritalStatus | required | MaritalStatusVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-marital-status-vsfrom this IG | |
| Patient.maritalStatus.extension:bypassEditFlag.value[x] | required | EditBypass0124VShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-edit-bypass-0124-vsfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| NVSS-SexAtDeath | 0..1 | CodeableConcept | NVSS Sex at Death URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender PHVS_Sex_MFU (required) | |
| Spouse-Alive | 0..1 | CodeableConcept | Spouse Alive? URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/SpouseAlive Binding: Spouse Alive Value Set (required) | |
| Patient-BirthPlace | 0..1 | Address | Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
 extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
 value[x] | 1..1 | Address | Value of extension | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Birthplace Country Value Set (required) |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system |
| identifier:ni | Σ | 0..1 | Identifier | National Identifier |
| 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. 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: NI | |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | Σ | 1..* | HumanName | A name associated with the patient |
| birthDate | Σ | 0..1 | date | Date of Birth |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| partialDate | 0..1 | (Complex) | partialDate URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PartialDate | |
 deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | Σ | 0..* | Address | Decedent's Residence |
| withinCityLimitsIndicator | 0..1 | Coding | Within City Limits Indicator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/WithinCityLimitsIndicator Binding: Yes No Unknown (required): Yes No Unknown | |
| predir | 0..1 | string | PreDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PreDirectional | |
| stnum | 0..1 | string | StreetNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetNumber | |
| stname | 0..1 | string | StreetName URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetName | |
| stdesig | 0..1 | string | StreetDesignator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetDesignator | |
| postdir | 0..1 | string | PostDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PostDirectional | |
| unitnumber | 0..1 | string | UnitOrAptNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/UnitOrAptNumber | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (example) |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Value Set (required) | |
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 0124 (required) | |
| text | Σ | 0..1 | string | Marital Description |
| contact | C | 0..* | BackboneElement | Informant information pat-1: SHALL at least contain a contact's details or a reference to an organization |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relationship | 0..1 | CodeableConcept | Informant Relationship (INFORMRELATE) Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| text | Σ | 0..1 | string | Informant Relationship (INFORMRELATE) - first 30 characters will be used |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Patient.extension:Patient-BirthPlace.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Patient.extension:Patient-BirthPlace.value[x].state | required | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | |
| Patient.extension:Patient-BirthPlace.value[x].country | required | BirthplaceCountryVS (a valid code from Country Codes)http://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-birthplace-country-vsfrom this IG | |
| Patient.identifier:ni.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Patient.identifier:ni.type | extensible | Pattern: NIhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Patient.address.state | example | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | |
| Patient.address.country | required | ResidenceCountryVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-residence-country-vsfrom this IG | |
| Patient.maritalStatus | required | MaritalStatusVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-marital-status-vsfrom this IG | |
| Patient.maritalStatus.extension:bypassEditFlag.value[x] | required | EditBypass0124VShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-edit-bypass-0124-vsfrom this IG | |
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| NVSS-SexAtDeath | 0..1 | CodeableConcept | NVSS Sex at Death URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender PHVS_Sex_MFU (required) | |||||
| Spouse-Alive | 0..1 | CodeableConcept | Spouse Alive? URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/SpouseAlive Binding: Spouse Alive Value Set (required) | |||||
| Patient-BirthPlace | 0..1 | Address | Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
| value[x] | 1..1 | Address | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| cityCode | 0..1 | positiveInt | City Code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/CityCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Birthplace Country Value Set (required) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system | ||||
| identifier:ni | Σ | 0..1 | Identifier | National Identifier | ||||
| 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. 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: NI | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name | Σ | 1..* | HumanName | A name associated with the patient | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | Date of Birth | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| partialDate | 0..1 | (Complex) | partialDate URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PartialDate | |||||
| value | 0..1 | date | Primitive value for date | |||||
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | Σ | 0..* | Address | Decedent's Residence | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| withinCityLimitsIndicator | 0..1 | Coding | Within City Limits Indicator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/WithinCityLimitsIndicator Binding: Yes No Unknown (required): Yes No Unknown | |||||
| predir | 0..1 | string | PreDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PreDirectional | |||||
| stnum | 0..1 | string | StreetNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetNumber | |||||
| stname | 0..1 | string | StreetName URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetName | |||||
| stdesig | 0..1 | string | StreetDesignator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetDesignator | |||||
| postdir | 0..1 | string | PostDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PostDirectional | |||||
| unitnumber | 0..1 | string | UnitOrAptNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/UnitOrAptNumber | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| cityCode | 0..1 | positiveInt | City Code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/CityCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| districtCode | 0..1 | positiveInt | County code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/DistrictCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (example) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) | ||||
| period | Σ | 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 Value Set (required) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag" | |||||
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 0124 (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Marital Description | ||||
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | C | 0..* | BackboneElement | Informant information pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | 0..1 | CodeableConcept | Informant Relationship (INFORMRELATE) Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Informant Relationship (INFORMRELATE) - first 30 characters will be used | ||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.extension:Patient-BirthPlace.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Patient.extension:Patient-BirthPlace.value[x].type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Patient.extension:Patient-BirthPlace.value[x].state | required | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | ||||
| Patient.extension:Patient-BirthPlace.value[x].country | required | BirthplaceCountryVS (a valid code from Country Codes)http://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-birthplace-country-vsfrom this IG | ||||
| Patient.identifier:ni.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Patient.identifier:ni.type | extensible | Pattern: NIhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Patient.address.state | example | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | ||||
| Patient.address.country | required | ResidenceCountryVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-residence-country-vsfrom this IG | ||||
| Patient.maritalStatus | required | MaritalStatusVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-marital-status-vsfrom this IG | ||||
| Patient.maritalStatus.extension:bypassEditFlag.value[x] | required | EditBypass0124VShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-edit-bypass-0124-vsfrom this IG | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
This structure is derived from Patient
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | Patient | |||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| NVSS-SexAtDeath | 0..1 | CodeableConcept | NVSS Sex at Death URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender PHVS_Sex_MFU (required) | |
| Spouse-Alive | 0..1 | CodeableConcept | Spouse Alive? URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/SpouseAlive Binding: Spouse Alive Value Set (required) | |
| Patient-BirthPlace | 0..1 | Address | Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
| value[x] | ||||
| city | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cityCode | 0..1 | positiveInt | City Code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/CityCode | |
| state | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) | |
| country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Birthplace Country Value Set (required) | |
| Slices for identifier | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system | |
| identifier:ni | 0..1 | Identifier | National Identifier | |
| type | 0..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: NI | |
| name | 1..* | HumanName | A name associated with the patient | |
| birthDate | 0..1 | date | Date of Birth | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| partialDate | 0..1 | (Complex) | partialDate URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PartialDate | |
| address | 0..* | Address | Decedent's Residence | |
| withinCityLimitsIndicator | 0..1 | Coding | Within City Limits Indicator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/WithinCityLimitsIndicator Binding: Yes No Unknown (required): Yes No Unknown | |
| predir | 0..1 | string | PreDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PreDirectional | |
| stnum | 0..1 | string | StreetNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetNumber | |
| stname | 0..1 | string | StreetName URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetName | |
| stdesig | 0..1 | string | StreetDesignator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetDesignator | |
| postdir | 0..1 | string | PostDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PostDirectional | |
| unitnumber | 0..1 | string | UnitOrAptNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/UnitOrAptNumber | |
| city | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cityCode | 0..1 | positiveInt | City Code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/CityCode | |
| district | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| districtCode | 0..1 | positiveInt | County code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/DistrictCode | |
| state | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (example) | |
| country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) | |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Value Set (required) | |
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 0124 (required) | |
| text | 0..1 | string | Marital Description | |
| contact | 0..* | BackboneElement | Informant information | |
| relationship | 0..1 | CodeableConcept | Informant Relationship (INFORMRELATE) | |
| text | 0..1 | string | Informant Relationship (INFORMRELATE) - first 30 characters will be used | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Patient.extension:Patient-BirthPlace.value[x].state | required | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | |
| Patient.extension:Patient-BirthPlace.value[x].country | required | BirthplaceCountryVS (a valid code from Country Codes)http://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-birthplace-country-vsfrom this IG | |
| Patient.address.state | example | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | |
| Patient.address.country | required | ResidenceCountryVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-residence-country-vsfrom this IG | |
| Patient.maritalStatus | required | MaritalStatusVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-marital-status-vsfrom this IG | |
| Patient.maritalStatus.extension:bypassEditFlag.value[x] | required | EditBypass0124VShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-edit-bypass-0124-vsfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| NVSS-SexAtDeath | 0..1 | CodeableConcept | NVSS Sex at Death URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender PHVS_Sex_MFU (required) | |
| Spouse-Alive | 0..1 | CodeableConcept | Spouse Alive? URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/SpouseAlive Binding: Spouse Alive Value Set (required) | |
| Patient-BirthPlace | 0..1 | Address | Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
| value[x] | 1..1 | Address | Value of extension | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Birthplace Country Value Set (required) |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system |
| identifier:ni | Σ | 0..1 | Identifier | National Identifier |
| 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. 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: NI | |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | Σ | 1..* | HumanName | A name associated with the patient |
| birthDate | Σ | 0..1 | date | Date of Birth |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| partialDate | 0..1 | (Complex) | partialDate URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PartialDate | |
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | Σ | 0..* | Address | Decedent's Residence |
| withinCityLimitsIndicator | 0..1 | Coding | Within City Limits Indicator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/WithinCityLimitsIndicator Binding: Yes No Unknown (required): Yes No Unknown | |
| predir | 0..1 | string | PreDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PreDirectional | |
| stnum | 0..1 | string | StreetNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetNumber | |
| stname | 0..1 | string | StreetName URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetName | |
| stdesig | 0..1 | string | StreetDesignator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetDesignator | |
| postdir | 0..1 | string | PostDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PostDirectional | |
| unitnumber | 0..1 | string | UnitOrAptNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/UnitOrAptNumber | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (example) |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Value Set (required) | |
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 0124 (required) | |
| text | Σ | 0..1 | string | Marital Description |
| contact | C | 0..* | BackboneElement | Informant information pat-1: SHALL at least contain a contact's details or a reference to an organization |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relationship | 0..1 | CodeableConcept | Informant Relationship (INFORMRELATE) Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| text | Σ | 0..1 | string | Informant Relationship (INFORMRELATE) - first 30 characters will be used |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Patient.extension:Patient-BirthPlace.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Patient.extension:Patient-BirthPlace.value[x].state | required | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | |
| Patient.extension:Patient-BirthPlace.value[x].country | required | BirthplaceCountryVS (a valid code from Country Codes)http://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-birthplace-country-vsfrom this IG | |
| Patient.identifier:ni.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Patient.identifier:ni.type | extensible | Pattern: NIhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Patient.address.state | example | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | |
| Patient.address.country | required | ResidenceCountryVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-residence-country-vsfrom this IG | |
| Patient.maritalStatus | required | MaritalStatusVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-marital-status-vsfrom this IG | |
| Patient.maritalStatus.extension:bypassEditFlag.value[x] | required | EditBypass0124VShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-edit-bypass-0124-vsfrom this IG | |
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| NVSS-SexAtDeath | 0..1 | CodeableConcept | NVSS Sex at Death URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender PHVS_Sex_MFU (required) | |||||
| Spouse-Alive | 0..1 | CodeableConcept | Spouse Alive? URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/SpouseAlive Binding: Spouse Alive Value Set (required) | |||||
| Patient-BirthPlace | 0..1 | Address | Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
| value[x] | 1..1 | Address | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| cityCode | 0..1 | positiveInt | City Code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/CityCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Birthplace Country Value Set (required) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system | ||||
| identifier:ni | Σ | 0..1 | Identifier | National Identifier | ||||
| 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. 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: NI | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name | Σ | 1..* | HumanName | A name associated with the patient | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | Date of Birth | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| partialDate | 0..1 | (Complex) | partialDate URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PartialDate | |||||
| value | 0..1 | date | Primitive value for date | |||||
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | Σ | 0..* | Address | Decedent's Residence | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| withinCityLimitsIndicator | 0..1 | Coding | Within City Limits Indicator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/WithinCityLimitsIndicator Binding: Yes No Unknown (required): Yes No Unknown | |||||
| predir | 0..1 | string | PreDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PreDirectional | |||||
| stnum | 0..1 | string | StreetNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetNumber | |||||
| stname | 0..1 | string | StreetName URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetName | |||||
| stdesig | 0..1 | string | StreetDesignator URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/StreetDesignator | |||||
| postdir | 0..1 | string | PostDirectional URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/PostDirectional | |||||
| unitnumber | 0..1 | string | UnitOrAptNumber URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/UnitOrAptNumber | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| cityCode | 0..1 | positiveInt | City Code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/CityCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| districtCode | 0..1 | positiveInt | County code URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/DistrictCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (example) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) | ||||
| period | Σ | 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 Value Set (required) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bypassEditFlag | 0..1 | CodeableConcept | BypassEditFlag URL: http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://profiles.ihe.net/QRPH/VRDR/StructureDefinition/BypassEditFlag" | |||||
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Edit Bypass 0124 (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Marital Description | ||||
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | C | 0..* | BackboneElement | Informant information pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | 0..1 | CodeableConcept | Informant Relationship (INFORMRELATE) Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Informant Relationship (INFORMRELATE) - first 30 characters will be used | ||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.extension:Patient-BirthPlace.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Patient.extension:Patient-BirthPlace.value[x].type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Patient.extension:Patient-BirthPlace.value[x].state | required | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | ||||
| Patient.extension:Patient-BirthPlace.value[x].country | required | BirthplaceCountryVS (a valid code from Country Codes)http://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-birthplace-country-vsfrom this IG | ||||
| Patient.identifier:ni.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Patient.identifier:ni.type | extensible | Pattern: NIhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Patient.address.state | example | StatesTerritoriesAndProvincesVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-states-territories-provinces-vsfrom this IG | ||||
| Patient.address.country | required | ResidenceCountryVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-residence-country-vsfrom this IG | ||||
| Patient.maritalStatus | required | MaritalStatusVShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-marital-status-vsfrom this IG | ||||
| Patient.maritalStatus.extension:bypassEditFlag.value[x] | required | EditBypass0124VShttp://profiles.ihe.net/QRPH/VRDR/ValueSet/vrdr-edit-bypass-0124-vsfrom this IG | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
This structure is derived from Patient
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ IHE Quality, Research and Public Health Technical Committee. Package ihe.qrph.vrdr#0.0.0-current based on FHIR 4.0.1. Generated 2024-03-11
Links: Table of Contents |
QA Report
Version History |
|
Propose a change