This is the set of resources that conform to both US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient) and HRex Patient Demographics (http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-patient-demographics).
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | ||||||
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
identifier | SΣ | 1..* | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children | ||||
name | SΣC | 1..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
use | ?!Σ | 0..1 | code | left: 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden; right: usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. ele-1: All FHIR elements must have a @value or children | ||||
text | Σ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children | ||||
family | SΣ | 1..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children | ||||
given | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children | ||||
prefix | Σ | 0..* | string | Parts that come before the name ele-1: All FHIR elements must have a @value or children | ||||
suffix | Σ | 0..* | string | left: 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name; right: Parts that come after the name ele-1: All FHIR elements must have a @value or children | ||||
period | Σ | 0..1 | Period | left: 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use; right: Time period when name was/is in use ele-1: All FHIR elements must have a @value or children | ||||
telecom | Σ | 0..* | ContactPoint | left: 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual; right: A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
gender | SΣ | 1..1 | code | male | female | other | unknown Binding: ?? (required) ele-1: All FHIR elements must have a @value or children | ||||
birthDate | SΣ | 1..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children | ||||
deceased[x] | ?!Σ | 0..1 | left: 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not; right: Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | SΣ | 0..* | Address | An address for the individual ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
use | ?!Σ | 0..1 | code | left: 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address; right: home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: ?? (required): The type of an address (physical / postal). ele-1: All FHIR elements must have a @value or children Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address ele-1: All FHIR elements must have a @value or children Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children Example General: 137 Nowhere Street Example General: 49 MEADOW ST | ||||
city | SΣ | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon Example General: EVERYTOWN | ||||
district | Σ | 0..1 | string | District name (aka county) ele-1: All FHIR elements must have a @value or children Example General: Madison | ||||
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes. ele-1: All FHIR elements must have a @value or children Example General: OK | ||||
postalCode | SΣ | 0..1 | string | left: US Zip Codes; right: Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 Example General: 74047 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children | ||||
period | SΣ | 0..1 | Period | left: 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use; right: Time period when address was/is in use ele-1: All FHIR elements must have a @value or children Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person. ele-1: All FHIR elements must have a @value or children | |||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient ele-1: All FHIR elements must have a @value or children | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient. ele-1: All FHIR elements must have a @value or children | |||||
name | 0..1 | HumanName | A name associated with the contact person ele-1: All FHIR elements must have a @value or children | |||||
telecom | 0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children | |||||
address | 0..1 | Address | Address for the contact person ele-1: All FHIR elements must have a @value or children | |||||
gender | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children | |||||
organization | 0..1 | Reference(Organization) | Organization that is associated with the contact ele-1: All FHIR elements must have a @value or children | |||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient ele-1: All FHIR elements must have a @value or children | |||||
communication | 0..* | BackboneElement | left: 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health; right: A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children | |||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible) ele-1: All FHIR elements must have a @value or children | ||||
preferred | 0..1 | boolean | Language preference indicator ele-1: All FHIR elements must have a @value or children | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |