Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/1.0/StructureDefinition/profile-Patient | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R2_Patient_R4B | ||
This cross-version profile allows DSTU2 Patient content to be represented via FHIR R4B Patient resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Patient |
0..* | Patient(4.3.0) | Information about an individual or animal receiving health care services | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
   modifierExtension:animal |
0..1 | (Complex) | DSTU2: This patient is known to be an animal (non-human) (new) URL: http://hl7.org/fhir/StructureDefinition/patient-animal Constraints: ext-1 | |
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
 deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean |
boolean | |||
 deceasedDateTime |
dateTime | |||
  link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
 Slices for modifierExtension |
?!Σ | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
| modifierExtension:type |
?!Σ | 0..1 | code | DSTU2: replace | refer | seealso - type of link additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.link.type Binding: R2LinkTypeForR4B (0.1.0) (required): The type of link between this patient resource and another patient resource. Constraints: ext-1 |
 other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.link.type | Base | required | LinkType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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.implicitRules, Patient.modifierExtension, Patient.modifierExtension:animal, Patient.active, Patient.deceased[x], Patient.link, Patient.link.modifierExtension, Patient.link.modifierExtension:type, Patient.link.other, Patient.link.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Patient.modifierExtension, Patient.modifierExtension:animal, Patient.link.modifierExtension, Patient.link.modifierExtension:type | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | Patient(4.3.0) | Information about an individual or animal receiving health care services | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:animal |
0..1 | (Complex) | DSTU2: This patient is known to be an animal (non-human) (new) URL: http://hl7.org/fhir/StructureDefinition/patient-animal Constraints: ext-1 | |||||
| identifier |
Σ | 0..* | Identifier | An identifier for this patient | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | DSTU2: identifier additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name |
Σ | 0..* | HumanName | A name associated with the patient | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:name |
0..* | HumanName | DSTU2: name additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.name Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given |
Σ | 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 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | DSTU2: telecom additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.telecom Constraints: ext-1 | |||||
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) | ||||
| value |
Σ | 0..1 | string | The actual contact point details | ||||
| use |
?!Σ | 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 |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| address |
Σ | 0..* | Address | An address for the individual | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:address |
0..* | Address | DSTU2: Addresses for the individual additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.address Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). 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) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:maritalStatus |
0..1 | CodeableConcept | DSTU2: maritalStatus additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.maritalStatus Binding: Marital Status Codes (required): The domestic partnership status of a person. Constraints: ext-1 | |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:photo |
0..* | Attachment | DSTU2: photo additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.photo Constraints: ext-1 | |||||
| contentType |
Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png | ||||
| language |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): IETF language tag
Example General: en-AU | ||||
| data |
0..1 | base64Binary | Data inline, base64ed | |||||
| url |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
| contact |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| relationship |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name |
0..1 | HumanName | A name associated with the contact person | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:name |
0..1 | HumanName | DSTU2: name additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.contact.name Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given |
Σ | 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 person | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | DSTU2: telecom additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.contact.telecom Constraints: ext-1 | |||||
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) | ||||
| value |
Σ | 0..1 | string | The actual contact point details | ||||
| use |
?!Σ | 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 | ||||
| address |
0..1 | Address | Address for the contact person | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:address |
0..1 | Address | DSTU2: address additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.contact.address Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). 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) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:organization |
0..1 | Reference(Resource) | DSTU2: organization additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| period |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:period |
0..1 | Period | DSTU2: period additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.contact.period Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): IETF language tag
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| generalPractitioner |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:careProvider |
0..1 | Reference(Resource) | DSTU2: careProvider additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| managingOrganization |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:managingOrganization |
0..1 | Reference(Resource) | DSTU2: managingOrganization additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 Constraints: ext-1 | |||||
| Slices for modifierExtension |
?!Σ | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:type |
?!Σ | 0..1 | code | DSTU2: replace | refer | seealso - type of link additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.link.type Binding: R2LinkTypeForR4B (0.1.0) (required): The type of link between this patient resource and another patient resource. Constraints: ext-1 | ||||
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Patient.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Patient.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Patient.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Patient.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Patient.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.3.0 | FHIR Std. |
| Patient.telecom.system | Base | required | ContactPointSystem | 📍4.3.0 | FHIR Std. |
| Patient.telecom.use | Base | required | ContactPointUse | 📍4.3.0 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.3.0 | FHIR Std. |
| Patient.address.use | Base | required | AddressUse | 📍4.3.0 | FHIR Std. |
| Patient.address.type | Base | required | AddressType | 📍4.3.0 | FHIR Std. |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.3.0 | FHIR Std. |
| Patient.photo.contentType | Base | required | MimeType | 📍4.3.0 | FHIR Std. |
| Patient.photo.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.3.0 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.3.0 | FHIR Std. |
| Patient.contact.telecom.system | Base | required | ContactPointSystem | 📍4.3.0 | FHIR Std. |
| Patient.contact.telecom.use | Base | required | ContactPointUse | 📍4.3.0 | FHIR Std. |
| Patient.contact.address.use | Base | required | AddressUse | 📍4.3.0 | FHIR Std. |
| Patient.contact.address.type | Base | required | AddressType | 📍4.3.0 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.3.0 | FHIR Std. |
| Patient.contact.organization.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Patient.generalPractitioner.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Patient.managingOrganization.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Patient.link.other.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Patient.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Patient.meta, Patient.meta.extension, Patient.meta.extension:meta, Patient.meta.versionId, Patient.meta.lastUpdated, Patient.meta.source, Patient.meta.profile, Patient.meta.security, Patient.meta.tag, Patient.implicitRules, Patient.language, Patient.text, Patient.text.extension, Patient.text.extension:text, Patient.text.status, Patient.text.div, Patient.extension, Patient.modifierExtension, Patient.modifierExtension:animal, Patient.identifier, Patient.identifier.extension, Patient.identifier.extension:identifier, Patient.identifier.use, Patient.identifier.type, Patient.identifier.system, Patient.identifier.value, Patient.identifier.period, Patient.identifier.assigner, Patient.active, Patient.name, Patient.name.extension, Patient.name.extension:name, Patient.name.use, Patient.name.text, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.name.period, Patient.telecom, Patient.telecom.extension, Patient.telecom.extension:telecom, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom.rank, Patient.telecom.period, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.extension, Patient.address.extension:address, Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.period, Patient.maritalStatus, Patient.maritalStatus.extension, Patient.maritalStatus.extension:maritalStatus, Patient.maritalStatus.coding, Patient.maritalStatus.text, Patient.multipleBirth[x], Patient.photo, Patient.photo.extension, Patient.photo.extension:photo, Patient.photo.contentType, Patient.photo.language, Patient.photo.data, Patient.photo.url, Patient.photo.size, Patient.photo.hash, Patient.photo.title, Patient.photo.creation, Patient.contact, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.name.extension, Patient.contact.name.extension:name, Patient.contact.name.use, Patient.contact.name.text, Patient.contact.name.family, Patient.contact.name.given, Patient.contact.name.prefix, Patient.contact.name.suffix, Patient.contact.name.period, Patient.contact.telecom, Patient.contact.telecom.extension, Patient.contact.telecom.extension:telecom, Patient.contact.telecom.system, Patient.contact.telecom.value, Patient.contact.telecom.use, Patient.contact.telecom.rank, Patient.contact.telecom.period, Patient.contact.address, Patient.contact.address.extension, Patient.contact.address.extension:address, Patient.contact.address.use, Patient.contact.address.type, Patient.contact.address.text, Patient.contact.address.line, Patient.contact.address.city, Patient.contact.address.district, Patient.contact.address.state, Patient.contact.address.postalCode, Patient.contact.address.country, Patient.contact.address.period, Patient.contact.gender, Patient.contact.organization, Patient.contact.organization.extension, Patient.contact.organization.extension:organization, Patient.contact.organization.reference, Patient.contact.organization.type, Patient.contact.organization.identifier, Patient.contact.organization.display, Patient.contact.period, Patient.contact.period.extension, Patient.contact.period.extension:period, Patient.contact.period.start, Patient.contact.period.end, Patient.communication, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.preferred, Patient.generalPractitioner, Patient.generalPractitioner.extension, Patient.generalPractitioner.extension:careProvider, Patient.generalPractitioner.reference, Patient.generalPractitioner.type, Patient.generalPractitioner.identifier, Patient.generalPractitioner.display, Patient.managingOrganization, Patient.managingOrganization.extension, Patient.managingOrganization.extension:managingOrganization, Patient.managingOrganization.reference, Patient.managingOrganization.type, Patient.managingOrganization.identifier, Patient.managingOrganization.display, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.modifierExtension:type, Patient.link.other, Patient.link.other.extension, Patient.link.other.reference, Patient.link.other.type, Patient.link.other.identifier, Patient.link.other.display, Patient.link.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Patient.meta.extension, Patient.meta.extension:meta, Patient.text.extension, Patient.text.extension:text, Patient.extension, Patient.modifierExtension, Patient.modifierExtension:animal, Patient.identifier.extension, Patient.identifier.extension:identifier, Patient.name.extension, Patient.name.extension:name, Patient.telecom.extension, Patient.telecom.extension:telecom, Patient.address.extension, Patient.address.extension:address, Patient.maritalStatus.extension, Patient.maritalStatus.extension:maritalStatus, Patient.photo.extension, Patient.photo.extension:photo, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.name.extension, Patient.contact.name.extension:name, Patient.contact.telecom.extension, Patient.contact.telecom.extension:telecom, Patient.contact.address.extension, Patient.contact.address.extension:address, Patient.contact.organization.extension, Patient.contact.organization.extension:organization, Patient.contact.period.extension, Patient.contact.period.extension:period, Patient.communication.extension, Patient.communication.modifierExtension, Patient.generalPractitioner.extension, Patient.generalPractitioner.extension:careProvider, Patient.managingOrganization.extension, Patient.managingOrganization.extension:managingOrganization, Patient.link.extension, Patient.link.modifierExtension, Patient.link.modifierExtension:type, Patient.link.other.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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()
|
| txt-1 | error | Patient.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Patient.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Patient
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | Patient(4.3.0) | Information about an individual or animal receiving health care services | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
| modifierExtension:animal |
0..1 | (Complex) | DSTU2: This patient is known to be an animal (non-human) (new) URL: http://hl7.org/fhir/StructureDefinition/patient-animal Constraints: ext-1 | |
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean |
boolean | |||
| deceasedDateTime |
dateTime | |||
| link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| Slices for modifierExtension |
?!Σ | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
| modifierExtension:type |
?!Σ | 0..1 | code | DSTU2: replace | refer | seealso - type of link additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.link.type Binding: R2LinkTypeForR4B (0.1.0) (required): The type of link between this patient resource and another patient resource. Constraints: ext-1 |
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.link.type | Base | required | LinkType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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.implicitRules, Patient.modifierExtension, Patient.modifierExtension:animal, Patient.active, Patient.deceased[x], Patient.link, Patient.link.modifierExtension, Patient.link.modifierExtension:type, Patient.link.other, Patient.link.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Patient.modifierExtension, Patient.modifierExtension:animal, Patient.link.modifierExtension, Patient.link.modifierExtension:type | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Patient
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | Patient(4.3.0) | Information about an individual or animal receiving health care services | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:animal |
0..1 | (Complex) | DSTU2: This patient is known to be an animal (non-human) (new) URL: http://hl7.org/fhir/StructureDefinition/patient-animal Constraints: ext-1 | |||||
| identifier |
Σ | 0..* | Identifier | An identifier for this patient | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | DSTU2: identifier additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name |
Σ | 0..* | HumanName | A name associated with the patient | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:name |
0..* | HumanName | DSTU2: name additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.name Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given |
Σ | 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 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | DSTU2: telecom additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.telecom Constraints: ext-1 | |||||
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) | ||||
| value |
Σ | 0..1 | string | The actual contact point details | ||||
| use |
?!Σ | 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 |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| address |
Σ | 0..* | Address | An address for the individual | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:address |
0..* | Address | DSTU2: Addresses for the individual additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.address Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). 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) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:maritalStatus |
0..1 | CodeableConcept | DSTU2: maritalStatus additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.maritalStatus Binding: Marital Status Codes (required): The domestic partnership status of a person. Constraints: ext-1 | |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:photo |
0..* | Attachment | DSTU2: photo additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.photo Constraints: ext-1 | |||||
| contentType |
Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png | ||||
| language |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): IETF language tag
Example General: en-AU | ||||
| data |
0..1 | base64Binary | Data inline, base64ed | |||||
| url |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
| contact |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| relationship |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name |
0..1 | HumanName | A name associated with the contact person | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:name |
0..1 | HumanName | DSTU2: name additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.contact.name Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given |
Σ | 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 person | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | DSTU2: telecom additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.contact.telecom Constraints: ext-1 | |||||
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) | ||||
| value |
Σ | 0..1 | string | The actual contact point details | ||||
| use |
?!Σ | 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 | ||||
| address |
0..1 | Address | Address for the contact person | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:address |
0..1 | Address | DSTU2: address additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.contact.address Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). 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) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:organization |
0..1 | Reference(Resource) | DSTU2: organization additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| period |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:period |
0..1 | Period | DSTU2: period additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.contact.period Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): IETF language tag
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| generalPractitioner |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:careProvider |
0..1 | Reference(Resource) | DSTU2: careProvider additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| managingOrganization |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:managingOrganization |
0..1 | Reference(Resource) | DSTU2: managingOrganization additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 Constraints: ext-1 | |||||
| Slices for modifierExtension |
?!Σ | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:type |
?!Σ | 0..1 | code | DSTU2: replace | refer | seealso - type of link additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Patient.link.type Binding: R2LinkTypeForR4B (0.1.0) (required): The type of link between this patient resource and another patient resource. Constraints: ext-1 | ||||
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Patient.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Patient.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Patient.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Patient.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Patient.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.3.0 | FHIR Std. |
| Patient.telecom.system | Base | required | ContactPointSystem | 📍4.3.0 | FHIR Std. |
| Patient.telecom.use | Base | required | ContactPointUse | 📍4.3.0 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.3.0 | FHIR Std. |
| Patient.address.use | Base | required | AddressUse | 📍4.3.0 | FHIR Std. |
| Patient.address.type | Base | required | AddressType | 📍4.3.0 | FHIR Std. |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.3.0 | FHIR Std. |
| Patient.photo.contentType | Base | required | MimeType | 📍4.3.0 | FHIR Std. |
| Patient.photo.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.3.0 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.3.0 | FHIR Std. |
| Patient.contact.telecom.system | Base | required | ContactPointSystem | 📍4.3.0 | FHIR Std. |
| Patient.contact.telecom.use | Base | required | ContactPointUse | 📍4.3.0 | FHIR Std. |
| Patient.contact.address.use | Base | required | AddressUse | 📍4.3.0 | FHIR Std. |
| Patient.contact.address.type | Base | required | AddressType | 📍4.3.0 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.3.0 | FHIR Std. |
| Patient.contact.organization.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Patient.generalPractitioner.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Patient.managingOrganization.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Patient.link.other.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Patient.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Patient.meta, Patient.meta.extension, Patient.meta.extension:meta, Patient.meta.versionId, Patient.meta.lastUpdated, Patient.meta.source, Patient.meta.profile, Patient.meta.security, Patient.meta.tag, Patient.implicitRules, Patient.language, Patient.text, Patient.text.extension, Patient.text.extension:text, Patient.text.status, Patient.text.div, Patient.extension, Patient.modifierExtension, Patient.modifierExtension:animal, Patient.identifier, Patient.identifier.extension, Patient.identifier.extension:identifier, Patient.identifier.use, Patient.identifier.type, Patient.identifier.system, Patient.identifier.value, Patient.identifier.period, Patient.identifier.assigner, Patient.active, Patient.name, Patient.name.extension, Patient.name.extension:name, Patient.name.use, Patient.name.text, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.name.period, Patient.telecom, Patient.telecom.extension, Patient.telecom.extension:telecom, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom.rank, Patient.telecom.period, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.extension, Patient.address.extension:address, Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.period, Patient.maritalStatus, Patient.maritalStatus.extension, Patient.maritalStatus.extension:maritalStatus, Patient.maritalStatus.coding, Patient.maritalStatus.text, Patient.multipleBirth[x], Patient.photo, Patient.photo.extension, Patient.photo.extension:photo, Patient.photo.contentType, Patient.photo.language, Patient.photo.data, Patient.photo.url, Patient.photo.size, Patient.photo.hash, Patient.photo.title, Patient.photo.creation, Patient.contact, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.name.extension, Patient.contact.name.extension:name, Patient.contact.name.use, Patient.contact.name.text, Patient.contact.name.family, Patient.contact.name.given, Patient.contact.name.prefix, Patient.contact.name.suffix, Patient.contact.name.period, Patient.contact.telecom, Patient.contact.telecom.extension, Patient.contact.telecom.extension:telecom, Patient.contact.telecom.system, Patient.contact.telecom.value, Patient.contact.telecom.use, Patient.contact.telecom.rank, Patient.contact.telecom.period, Patient.contact.address, Patient.contact.address.extension, Patient.contact.address.extension:address, Patient.contact.address.use, Patient.contact.address.type, Patient.contact.address.text, Patient.contact.address.line, Patient.contact.address.city, Patient.contact.address.district, Patient.contact.address.state, Patient.contact.address.postalCode, Patient.contact.address.country, Patient.contact.address.period, Patient.contact.gender, Patient.contact.organization, Patient.contact.organization.extension, Patient.contact.organization.extension:organization, Patient.contact.organization.reference, Patient.contact.organization.type, Patient.contact.organization.identifier, Patient.contact.organization.display, Patient.contact.period, Patient.contact.period.extension, Patient.contact.period.extension:period, Patient.contact.period.start, Patient.contact.period.end, Patient.communication, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.preferred, Patient.generalPractitioner, Patient.generalPractitioner.extension, Patient.generalPractitioner.extension:careProvider, Patient.generalPractitioner.reference, Patient.generalPractitioner.type, Patient.generalPractitioner.identifier, Patient.generalPractitioner.display, Patient.managingOrganization, Patient.managingOrganization.extension, Patient.managingOrganization.extension:managingOrganization, Patient.managingOrganization.reference, Patient.managingOrganization.type, Patient.managingOrganization.identifier, Patient.managingOrganization.display, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.modifierExtension:type, Patient.link.other, Patient.link.other.extension, Patient.link.other.reference, Patient.link.other.type, Patient.link.other.identifier, Patient.link.other.display, Patient.link.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Patient.meta.extension, Patient.meta.extension:meta, Patient.text.extension, Patient.text.extension:text, Patient.extension, Patient.modifierExtension, Patient.modifierExtension:animal, Patient.identifier.extension, Patient.identifier.extension:identifier, Patient.name.extension, Patient.name.extension:name, Patient.telecom.extension, Patient.telecom.extension:telecom, Patient.address.extension, Patient.address.extension:address, Patient.maritalStatus.extension, Patient.maritalStatus.extension:maritalStatus, Patient.photo.extension, Patient.photo.extension:photo, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.name.extension, Patient.contact.name.extension:name, Patient.contact.telecom.extension, Patient.contact.telecom.extension:telecom, Patient.contact.address.extension, Patient.contact.address.extension:address, Patient.contact.organization.extension, Patient.contact.organization.extension:organization, Patient.contact.period.extension, Patient.contact.period.extension:period, Patient.communication.extension, Patient.communication.modifierExtension, Patient.generalPractitioner.extension, Patient.generalPractitioner.extension:careProvider, Patient.managingOrganization.extension, Patient.managingOrganization.extension:managingOrganization, Patient.link.extension, Patient.link.modifierExtension, Patient.link.modifierExtension:type, Patient.link.other.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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()
|
| txt-1 | error | Patient.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Patient.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Patient
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r2.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
