This is the set of resources that conform to either of the profiles Patient Profile - United States - Allowable Data (http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-patient-us-ad) and Patient Profile - United States - Allowable Data (http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-patient-us-ad). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Information about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test 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 | 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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 | Official name (i.e., legal name) of patient ele-1: All FHIR elements must have a @value or children vc-name-invariant: Require one of the key name elements to be filled. Allows for `text` for names that cannot be cleanly categorized into `family` or `given` (https://www.nature.com/articles/d41586-020-02761-z). |
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 | 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 | left: Use instead of `family` and `given` if the patient's name cannot be easily split these elements; right: Use instead of `family` and `given` if the patient's name cannot be easily split into these elements ele-1: All FHIR elements must have a @value or children |
family | SΣ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children |
given | SΣ | 0..* | string | left: Given names (not always 'first'). Includes middle names; right: Parts of patient's name other than their family name that appear on photo ID; e.g., first and middle names ele-1: All FHIR elements must have a @value or children |
prefix | SΣ | 0..* | string | Parts that come before the name ele-1: All FHIR elements must have a @value or children |
suffix | SΣ | 0..* | string | Parts that come after the name ele-1: All FHIR elements must have a @value or children |
period | Σ | 0..1 | Period | Time period when name was/is in use ele-1: All FHIR elements must have a @value or children |
telecom | Σ | 0..* | ContactPoint | A contact detail 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 | |
system | Σ | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
value | ΣC | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children vc-should-be-omitted-privacy: SHOULD be omitted to protect privacy and for data minimization. |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children |
birthDate | SΣ | 0..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | Σ | 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 | 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 |
city | ΣC | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children vc-should-be-omitted-privacy: SHOULD be omitted to protect privacy and for data minimization. Example General: Erewhon |
district | ΣC | 0..1 | string | District name (aka county) ele-1: All FHIR elements must have a @value or children vc-should-be-omitted-privacy: SHOULD be omitted to protect privacy and for data minimization. Example General: Madison |
state | ΣC | 0..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children vc-should-be-omitted-privacy: SHOULD be omitted to protect privacy and for data minimization. |
postalCode | ΣC | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children vc-should-be-omitted-privacy: SHOULD be omitted to protect privacy and for data minimization. Example General: 9132 |
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 | Σ | 0..1 | Period | 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 | |||
communication | 0..* | BackboneElement | 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 | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (preferred): A human language. 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 |