Da Vinci Health Record Exchange (HRex), published by HL7 International - Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-patient-demographics | Version: 1.0.0 | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: HRexPatientDemographics |
Defines constraints on the patient resource for the minimal set of data to query and retrieve patient demographic information.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Patient | Information about an individual or animal receiving health care services hrex-pat-1: Patient gender or birthSex extension SHALL be present |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 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 |
![]() ![]() ![]() | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | Unique Member Identifier. This is required to be present for the 'new' coverage and be absent for the 'old' coverage. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UMB | |
![]() ![]() ![]() | S | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | S | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | S | 1..* | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() | S | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | S | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() | S | 0..* | Address | An address for the individual |
![]() ![]() ![]() ![]() | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() ![]() | S | 0..1 | string | Name of city, town etc. |
![]() ![]() ![]() ![]() | S | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() | S | 0..1 | string | Postal code for area |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when address was/is in use |
![]() |
Path | Conformance | ValueSet |
Patient.gender | required | AdministrativeGender |
Id | Grade | Path(s) | Details | Requirements |
hrex-pat-1 | error | Patient | Patient gender or birthSex extension SHALL be present : gender.exists() or extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex').exists() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Patient | Information about an individual or animal receiving health care services hrex-pat-1: Patient gender or birthSex extension SHALL be present |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 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 |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | Unique Member Identifier. This is required to be present for the 'new' coverage and be absent for the 'old' coverage. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UMB | |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | SΣ | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | SΣ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | SΣ | 0..* | Address | An address for the individual |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() | 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 |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
![]() |
Path | Conformance | ValueSet |
Patient.name.use | required | NameUse |
Patient.gender | required | AdministrativeGender |
Patient.address.use | required | AddressUse |
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
hrex-pat-1 | error | Patient | Patient gender or birthSex extension SHALL be present : gender.exists() or extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex').exists() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | C | 0..* | Patient | Information about an individual or animal receiving health care services hrex-pat-1: Patient gender or birthSex extension SHALL be present | ||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 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 | ||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | Unique Member Identifier. This is required to be present for the 'new' coverage and be absent for the 'old' coverage. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UMB | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | The namespace for the identifier value | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | SΣ | 1..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
![]() ![]() ![]() | SΣ | 1..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | SΣ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() | 0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 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.
| |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.name.use | required | NameUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.address.use | required | AddressUse | ||||
Patient.address.type | required | AddressType | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
hrex-pat-1 | error | Patient | Patient gender or birthSex extension SHALL be present : gender.exists() or extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex').exists() |
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Patient | Information about an individual or animal receiving health care services hrex-pat-1: Patient gender or birthSex extension SHALL be present |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 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 |
![]() ![]() ![]() | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | Unique Member Identifier. This is required to be present for the 'new' coverage and be absent for the 'old' coverage. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UMB | |
![]() ![]() ![]() | S | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | S | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | S | 1..* | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() | S | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | S | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() | S | 0..* | Address | An address for the individual |
![]() ![]() ![]() ![]() | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() ![]() | S | 0..1 | string | Name of city, town etc. |
![]() ![]() ![]() ![]() | S | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() | S | 0..1 | string | Postal code for area |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when address was/is in use |
![]() |
Path | Conformance | ValueSet |
Patient.gender | required | AdministrativeGender |
Id | Grade | Path(s) | Details | Requirements |
hrex-pat-1 | error | Patient | Patient gender or birthSex extension SHALL be present : gender.exists() or extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex').exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | C | 0..* | Patient | Information about an individual or animal receiving health care services hrex-pat-1: Patient gender or birthSex extension SHALL be present |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 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 |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | Unique Member Identifier. This is required to be present for the 'new' coverage and be absent for the 'old' coverage. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UMB | |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | SΣ | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | SΣ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | SΣ | 0..* | Address | An address for the individual |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() | 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 |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
![]() |
Path | Conformance | ValueSet |
Patient.name.use | required | NameUse |
Patient.gender | required | AdministrativeGender |
Patient.address.use | required | AddressUse |
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
hrex-pat-1 | error | Patient | Patient gender or birthSex extension SHALL be present : gender.exists() or extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex').exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | C | 0..* | Patient | Information about an individual or animal receiving health care services hrex-pat-1: Patient gender or birthSex extension SHALL be present | ||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 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 | ||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | Unique Member Identifier. This is required to be present for the 'new' coverage and be absent for the 'old' coverage. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UMB | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | The namespace for the identifier value | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | SΣ | 1..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
![]() ![]() ![]() | SΣ | 1..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | SΣ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() | 0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 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.
| |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.name.use | required | NameUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.address.use | required | AddressUse | ||||
Patient.address.type | required | AddressType | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
hrex-pat-1 | error | Patient | Patient gender or birthSex extension SHALL be present : gender.exists() or extension('http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex').exists() |
Other representations of profile: CSV, Excel, Schematron