Vital Records Death Reporting FHIR Implementation Guide - Local Development build (v1.1.0). See the Directory of published versions
Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Decedent | Version: 1.1.0 | |||
Active as of 2020-05-09 | Computable Name: Decedent |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePatientProfile
Summary
Mandatory: 3 elements
Must-Support: 6 elements
Extensions
This structure refers to these extensions:
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 | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
us-core-race | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
us-core-ethnicity | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
us-core-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 | |
NVSS-Race | S | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-Race |
NVSS-Ethnicity | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-Ethnicity |
patient-birthPlace | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | |
Slices for 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 |
district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
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: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=8B471CEB-EA88-45A4-8FAD-7805402A53F7 (required): PHVS_DecedentBirthplace_Country |
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 |
identifier | SΣ | 1..* | Identifier | An identifier for this patient |
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 | |
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) |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
name | SΣI | 1..* | HumanName | A name associated with the patient |
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 | |
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ΣI | 0..1 | string | Family name (often called 'Surname') |
given | SΣI | 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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 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: Administrative Gender (required): PHVS_Sex_MFU |
birthDate | SΣ | 0..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 | |
VRDR-Partial-date-part-absent-reason | S | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | partialDatePartAbsentReason URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Partial-date-part-absent-reason |
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 | SΣ | 0..* | Address | An address for the individual |
id | 0..1 | string | Unique id for inter-element referencing | |
Within-City-Limits-Indicator | 0..1 | Coding | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Within-City-Limits-Indicator Slice: Unordered, Open by value:url Binding: Yes No Unknown (required): Yes No Unknown | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
addressCityCode | S | 0..1 | positiveInt | address city code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/addressCityCode |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
district | Σ | 0..1 | string | District name (aka county) Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=C2F2220B-270F-4BDF-9F8C-D5CB369F7212 (required): PHVS_DivisionVitalStatistics__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) Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=BF77DB9E-1023-4CBE-A79D-7354FF9C968C (required): PHVS_DecedentResident_Country |
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 (required): PHVS_MaritalStatus_NCHS | |
id | 0..1 | string | Unique id for inter-element referencing | |
bypassEditFlag | 0..1 | Coding | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/bypassEditFlag Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept |
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||
multipleBirthBoolean | boolean | |||
multipleBirthInteger | integer | |||
photo | 0..* | Attachment | Image of the patient | |
contact | I | 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..1 | CodeableConcept | The kind of relationship Binding: PatientRelationshipType (required): relatedperson-relationshiptype | |
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 | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format |
This structure is derived from USCorePatientProfile
Summary
Mandatory: 3 elements
Must-Support: 6 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCorePatientProfile
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
us-core-race | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
us-core-ethnicity | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
us-core-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 | |
NVSS-Race | S | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-Race |
NVSS-Ethnicity | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-Ethnicity |
patient-birthPlace | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for 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 | |
Slices for 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 |
district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
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: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=8B471CEB-EA88-45A4-8FAD-7805402A53F7 (required): PHVS_DecedentBirthplace_Country |
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 |
identifier | SΣ | 1..* | Identifier | An identifier for this patient |
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 | |
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) |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
name | SΣI | 1..* | HumanName | A name associated with the patient |
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 | |
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ΣI | 0..1 | string | Family name (often called 'Surname') |
given | SΣI | 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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 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: Administrative Gender (required): PHVS_Sex_MFU |
birthDate | SΣ | 0..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 | |
VRDR-Partial-date-part-absent-reason | S | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | partialDatePartAbsentReason URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Partial-date-part-absent-reason |
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 | SΣ | 0..* | Address | An address for the individual |
id | 0..1 | string | Unique id for inter-element referencing | |
Within-City-Limits-Indicator | 0..1 | Coding | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Within-City-Limits-Indicator Slice: Unordered, Open by value:url Binding: Yes No Unknown (required): Yes No Unknown | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
addressCityCode | S | 0..1 | positiveInt | address city code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/addressCityCode |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
district | Σ | 0..1 | string | District name (aka county) Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=C2F2220B-270F-4BDF-9F8C-D5CB369F7212 (required): PHVS_DivisionVitalStatistics__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) Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=BF77DB9E-1023-4CBE-A79D-7354FF9C968C (required): PHVS_DecedentResident_Country |
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 (required): PHVS_MaritalStatus_NCHS | |
id | 0..1 | string | Unique id for inter-element referencing | |
bypassEditFlag | 0..1 | Coding | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/bypassEditFlag Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept |
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||
multipleBirthBoolean | boolean | |||
multipleBirthInteger | integer | |||
photo | 0..* | Attachment | Image of the patient | |
contact | I | 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..1 | CodeableConcept | The kind of relationship Binding: PatientRelationshipType (required): relatedperson-relationshiptype | |
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 | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Id | Grade | Path | 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 | Patient.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.extension:race | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.extension:race | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.extension:ethnicity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.extension:ethnicity | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.extension:birthsex | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.extension:birthsex | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.extension:NVSS-Race | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.extension:NVSS-Race | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.extension:NVSS-Ethnicity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.extension:NVSS-Ethnicity | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.extension:patient-birthPlace | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.extension:patient-birthPlace | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.extension:patient-birthPlace.value[x].extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.extension:patient-birthPlace.value[x].period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
us-core-8 | error | Patient.name | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() | |
ele-1 | error | Patient.name.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.name.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.name.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.name.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.name.family | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.name.given | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.name.prefix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.name.suffix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.name.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.telecom.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.telecom.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.telecom.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.telecom.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.telecom.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.telecom.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.telecom.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.birthDate.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.birthDate.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.birthDate.extension:partialDatePartAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.birthDate.extension:partialDatePartAbsentReason | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.deceased[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.address.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.address.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.city.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.address.city.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.address.district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.address.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.maritalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.maritalStatus.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.maritalStatus.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.maritalStatus.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.maritalStatus.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.multipleBirth[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
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() | |
ele-1 | error | Patient.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.contact.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.contact.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.contact.organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.contact.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.generalPractitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Patient.link.other | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Patient.link.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |