0.1.0 - ci-build
CAREWareFHIRDataDictionary - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://jprog.com/StructureDefinition/careware-patient | Version: 0.1.0 | |||
Draft as of 2025-06-19 | Computable Name: MyCAREWarePatient |
A patient profile that maps CSV columns for exp_client to various elements inside of the patient resource
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Patient | 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 | |
![]() ![]() ![]() |
SΣ | 1..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
1..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..2 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: home |
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: work |
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: temp |
![]() ![]() ![]() |
SΣ | 1..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Σ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Address | An address for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Required Pattern: home |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | District name (aka county) ele-1: All FHIR elements must have a @value or children Example General: Madison |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 |
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.telecom:phone1.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:phone1.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.telecom:mailingPhone1.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:mailingPhone1.use | required | Pattern: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.telecom:mailingPhone2.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:mailingPhone2.use | required | Pattern: temphttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.address:home.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() |
S | 1..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
![]() ![]() ![]() ![]() |
1..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
![]() ![]() ![]() |
S | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
S | 1..2 | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home | |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: work | |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: temp | |
![]() ![]() ![]() |
S | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() |
1..* | Address | An address for the individual Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() |
1..1 | Address | An address for the individual | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: home | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name of city, town etc. |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | District name (aka county) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Postal code for area |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() |
SΣ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..2 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Σ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Address | An address for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:phone1.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:phone1.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:mailingPhone1.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:mailingPhone1.use | required | Pattern: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:mailingPhone2.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:mailingPhone2.use | required | Pattern: temphttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address:home.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address:home.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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() |
This structure is derived from Patient
Summary
Mandatory: 15 elements(9 nested mandatory elements)
Must-Support: 14 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Patient | 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 | |
![]() ![]() ![]() |
SΣ | 1..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
1..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..2 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: home |
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: work |
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Required Pattern: temp |
![]() ![]() ![]() |
SΣ | 1..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Σ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Address | An address for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Required Pattern: home |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | District name (aka county) ele-1: All FHIR elements must have a @value or children Example General: Madison |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 |
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.telecom:phone1.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:phone1.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.telecom:mailingPhone1.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:mailingPhone1.use | required | Pattern: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.telecom:mailingPhone2.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:mailingPhone2.use | required | Pattern: temphttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.address:home.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() |
S | 1..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
![]() ![]() ![]() ![]() |
1..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
![]() ![]() ![]() |
S | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
S | 1..2 | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home | |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: work | |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: temp | |
![]() ![]() ![]() |
S | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() |
1..* | Address | An address for the individual Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() |
1..1 | Address | An address for the individual | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: home | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name of city, town etc. |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | District name (aka county) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Postal code for area |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() |
SΣ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..2 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Σ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Address | An address for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:phone1.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:phone1.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:mailingPhone1.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:mailingPhone1.use | required | Pattern: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:mailingPhone2.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:mailingPhone2.use | required | Pattern: temphttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address:home.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address:home.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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() |
This structure is derived from Patient
Summary
Mandatory: 15 elements(9 nested mandatory elements)
Must-Support: 14 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron