HL7® Austria FHIR® Core Implementation Guide
1.1.0 - STU2
HL7® Austria FHIR® Core Implementation Guide - Local Development build (v1.1.0). See the Directory of published versions
Defining URL: | http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-patient |
Version: | 1.1.0 |
Name: | HL7ATCorePatient |
Title: | HL7® AT Core Patient Profile |
Status: | Active as of 2023-02-14 16:55:37+0000 |
Definition: | HL7® Austria FHIR® Core Profile for patient data in Austria. The HL7® AT Core Patient is based upon the core FHIR® Patient Resource and designed to meet the applicable patient demographic data elements in Austria. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile. Note, this extension represents the common structure of Patient information within Austrian information systems. |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-patient
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Summary
Mandatory: 2 elements (7 nested mandatory elements)
Fixed Value: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
citizenship | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |
extension:code | 0..1 | Extension | Extension | |
valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: ELGA Country Code Value Set (extensible) | |
coding | ||||
system | 0..1 | uri | URL for ISO 3166-1 alpha 3 2016 Fixed Value: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/CodeSystem/at-core-cs-iso-3166-1-alpha-3 | |
PatientReligion | 0..1 | (Complex) | Patient Religion URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-patient-religion | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.code | |
identifier:socialSecurityNumber | 0..1 | Identifier | An identifier for this patient | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |
display | 0..1 | string | Representation defined by the system Fixed Value: Social Security Number | |
system | 1..1 | uri | OID for the Social Security Number in Austria Fixed Value: urn:oid:1.2.40.0.10.1.4.3.1 | |
value | 0..1 | string | The value that is unique | |
assigner | ||||
display | 0..1 | string | Text alternative for the resource Fixed Value: Dachverband der österreichischen Sozialversicherungsträger | |
identifier:bPK | 0..* | Identifier | An identifier for this patient | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
display | 0..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | |
system | 1..1 | uri | OID for the bPK in Austria Fixed Value: urn:oid:1.2.40.0.10.2.1.1.149 | |
value | 0..1 | string | The value that is unique | |
assigner | ||||
display | 0..1 | string | Text alternative for the resource Fixed Value: Bundesministerium für Inneres | |
identifier:localPatientId | 0..1 | Identifier | An identifier for this patient | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
display | 0..1 | string | Representation defined by the system Fixed Value: Patient internal identifier | |
system | 1..1 | uri | Namespace that assigned the localPatientId. | |
value | 0..1 | string | The value that is unique | |
active | 0..1 | boolean | Whether this patient's record is in active use | |
name | 1..* | HumanName | A name associated with the patient | |
family | 0..1 | string | Family name (often called 'Surname') | |
given | 0..* | string | Given names (not always 'first'). Includes middle names | |
prefix | 0..* | string | Parts that come before the name | |
suffix | 0..* | string | Parts that come after the name | |
telecom | ||||
system | 0..1 | code | phone | fax | email | pager | url | sms | other | |
value | 0..1 | string | The actual contact point details | |
use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
gender | 1..1 | code | male | female | other | unknown | |
birthDate | 0..1 | date | The date of birth for the individual | |
deceasedBoolean | 0..1 | boolean | Indicates if the individual is deceased or not | |
deceasedDateTime | 0..1 | dateTime | Indicates if the individual is deceased or not | |
address | 0..* | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
use | 0..1 | code | home | work | temp | old | billing - purpose of this address | |
text | 0..1 | string | Text representation of the address | |
line | 0..* | string | Street name, number, direction & P.O. Box etc. | |
city | 0..1 | string | Name of city, town etc. | |
state | 0..1 | string | Sub-unit of country (abbreviations ok) | |
postalCode | 0..1 | string | Postal code for area | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
maritalStatus | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
multipleBirthBoolean | 0..1 | boolean | Whether patient is part of a multiple birth | |
multipleBirthInteger | 0..1 | integer | Whether patient is part of a multiple birth | |
photo | 0..* | Attachment | Image of the patient | |
contact | ||||
relationship | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
name | ||||
family | 0..1 | string | Family name (often called 'Surname') | |
given | 0..* | string | Given names (not always 'first'). Includes middle names | |
telecom | ||||
system | 0..1 | code | phone | fax | email | pager | url | sms | other | |
value | 0..1 | string | The actual contact point details | |
use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
address | 0..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
use | 0..1 | code | home | work | temp | old | billing - purpose of this address | |
text | 0..1 | string | Text representation of the address | |
line | 0..* | string | Street name, number, direction & P.O. Box etc. | |
city | 0..1 | string | Name of city, town etc. | |
state | 0..1 | string | Sub-unit of country (abbreviations ok) | |
postalCode | 0..1 | string | Postal code for area | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
gender | 0..1 | code | male | female | other | unknown | |
organization | 0..1 | Reference(Organization) | Organization that is associated with the contact | |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
communication | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
managingOrganization | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |
link | ||||
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 | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | 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 | ||||
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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
citizenship | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
extension:code | 0..1 | Extension | Extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "code" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: ELGA Country Code Value Set (extensible) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | URL for ISO 3166-1 alpha 3 2016 Fixed Value: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/CodeSystem/at-core-cs-iso-3166-1-alpha-3 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
extension:period | 0..1 | Extension | Time period of citizenship | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "period" | |||||
value[x] | 1..1 | Period | Value of extension | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |||||
PatientReligion | 0..1 | (Complex) | Patient Religion URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-patient-religion | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.code | ||||
identifier:socialSecurityNumber | Σ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | ||||
display | Σ | 0..1 | string | Representation defined by the system Fixed Value: Social Security Number | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | OID for the Social Security Number in Austria Fixed Value: urn:oid:1.2.40.0.10.1.4.3.1 | ||||
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) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Dachverband der österreichischen Sozialversicherungsträger | ||||
identifier:bPK | Σ | 0..* | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | ||||
display | Σ | 0..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | OID for the bPK in Austria Fixed Value: urn:oid:1.2.40.0.10.2.1.1.149 | ||||
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) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Bundesministerium für Inneres | ||||
identifier:localPatientId | Σ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | ||||
display | Σ | 0..1 | string | Representation defined by the system Fixed Value: Patient internal identifier | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | Namespace that assigned the localPatientId. 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 | Σ | 1..* | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
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 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
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): Use of contact point. | ||||
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 | Σ | 1..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 | ||||
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not | ||||
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
address | C | 0..* | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. 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 | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
street | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
streetNumber | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
floorDoorNumber | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |||||
additionalInformation | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
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) | ||||
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 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
multipleBirth[x]:multipleBirthBoolean | 0..1 | boolean | Whether patient is part of a multiple birth | |||||
multipleBirth[x]:multipleBirthInteger | 0..1 | integer | Whether patient is part of a multiple birth | |||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
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 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
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): Use of contact point. | ||||
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 | C | 0..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. 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 | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
street | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
streetNumber | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
floorDoorNumber | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |||||
additionalInformation | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
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) | ||||
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 | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 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.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
Documentation for this format |
This structure is derived from Patient
Summary
Mandatory: 2 elements (7 nested mandatory elements)
Fixed Value: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
citizenship | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |
extension:code | 0..1 | Extension | Extension | |
valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: ELGA Country Code Value Set (extensible) | |
coding | ||||
system | 0..1 | uri | URL for ISO 3166-1 alpha 3 2016 Fixed Value: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/CodeSystem/at-core-cs-iso-3166-1-alpha-3 | |
PatientReligion | 0..1 | (Complex) | Patient Religion URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-patient-religion | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.code | |
identifier:socialSecurityNumber | 0..1 | Identifier | An identifier for this patient | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | |
display | 0..1 | string | Representation defined by the system Fixed Value: Social Security Number | |
system | 1..1 | uri | OID for the Social Security Number in Austria Fixed Value: urn:oid:1.2.40.0.10.1.4.3.1 | |
value | 0..1 | string | The value that is unique | |
assigner | ||||
display | 0..1 | string | Text alternative for the resource Fixed Value: Dachverband der österreichischen Sozialversicherungsträger | |
identifier:bPK | 0..* | Identifier | An identifier for this patient | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
display | 0..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | |
system | 1..1 | uri | OID for the bPK in Austria Fixed Value: urn:oid:1.2.40.0.10.2.1.1.149 | |
value | 0..1 | string | The value that is unique | |
assigner | ||||
display | 0..1 | string | Text alternative for the resource Fixed Value: Bundesministerium für Inneres | |
identifier:localPatientId | 0..1 | Identifier | An identifier for this patient | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
display | 0..1 | string | Representation defined by the system Fixed Value: Patient internal identifier | |
system | 1..1 | uri | Namespace that assigned the localPatientId. | |
value | 0..1 | string | The value that is unique | |
active | 0..1 | boolean | Whether this patient's record is in active use | |
name | 1..* | HumanName | A name associated with the patient | |
family | 0..1 | string | Family name (often called 'Surname') | |
given | 0..* | string | Given names (not always 'first'). Includes middle names | |
prefix | 0..* | string | Parts that come before the name | |
suffix | 0..* | string | Parts that come after the name | |
telecom | ||||
system | 0..1 | code | phone | fax | email | pager | url | sms | other | |
value | 0..1 | string | The actual contact point details | |
use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
gender | 1..1 | code | male | female | other | unknown | |
birthDate | 0..1 | date | The date of birth for the individual | |
deceasedBoolean | 0..1 | boolean | Indicates if the individual is deceased or not | |
deceasedDateTime | 0..1 | dateTime | Indicates if the individual is deceased or not | |
address | 0..* | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
use | 0..1 | code | home | work | temp | old | billing - purpose of this address | |
text | 0..1 | string | Text representation of the address | |
line | 0..* | string | Street name, number, direction & P.O. Box etc. | |
city | 0..1 | string | Name of city, town etc. | |
state | 0..1 | string | Sub-unit of country (abbreviations ok) | |
postalCode | 0..1 | string | Postal code for area | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
maritalStatus | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
multipleBirthBoolean | 0..1 | boolean | Whether patient is part of a multiple birth | |
multipleBirthInteger | 0..1 | integer | Whether patient is part of a multiple birth | |
photo | 0..* | Attachment | Image of the patient | |
contact | ||||
relationship | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
name | ||||
family | 0..1 | string | Family name (often called 'Surname') | |
given | 0..* | string | Given names (not always 'first'). Includes middle names | |
telecom | ||||
system | 0..1 | code | phone | fax | email | pager | url | sms | other | |
value | 0..1 | string | The actual contact point details | |
use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
address | 0..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
use | 0..1 | code | home | work | temp | old | billing - purpose of this address | |
text | 0..1 | string | Text representation of the address | |
line | 0..* | string | Street name, number, direction & P.O. Box etc. | |
city | 0..1 | string | Name of city, town etc. | |
state | 0..1 | string | Sub-unit of country (abbreviations ok) | |
postalCode | 0..1 | string | Postal code for area | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
gender | 0..1 | code | male | female | other | unknown | |
organization | 0..1 | Reference(Organization) | Organization that is associated with the contact | |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
communication | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
managingOrganization | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |
link | ||||
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 | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | 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 | ||||
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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
citizenship | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
extension:code | 0..1 | Extension | Extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "code" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: ELGA Country Code Value Set (extensible) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | URL for ISO 3166-1 alpha 3 2016 Fixed Value: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/CodeSystem/at-core-cs-iso-3166-1-alpha-3 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
extension:period | 0..1 | Extension | Time period of citizenship | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "period" | |||||
value[x] | 1..1 | Period | Value of extension | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |||||
PatientReligion | 0..1 | (Complex) | Patient Religion URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-patient-religion | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.code | ||||
identifier:socialSecurityNumber | Σ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SS | ||||
display | Σ | 0..1 | string | Representation defined by the system Fixed Value: Social Security Number | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | OID for the Social Security Number in Austria Fixed Value: urn:oid:1.2.40.0.10.1.4.3.1 | ||||
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) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Dachverband der österreichischen Sozialversicherungsträger | ||||
identifier:bPK | Σ | 0..* | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | ||||
display | Σ | 0..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | OID for the bPK in Austria Fixed Value: urn:oid:1.2.40.0.10.2.1.1.149 | ||||
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) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Bundesministerium für Inneres | ||||
identifier:localPatientId | Σ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | ||||
display | Σ | 0..1 | string | Representation defined by the system Fixed Value: Patient internal identifier | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | Namespace that assigned the localPatientId. 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 | Σ | 1..* | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
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 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
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): Use of contact point. | ||||
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 | Σ | 1..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 | ||||
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | Indicates if the individual is deceased or not | ||||
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
address | C | 0..* | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. 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 | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
street | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
streetNumber | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
floorDoorNumber | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |||||
additionalInformation | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
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) | ||||
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 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
multipleBirth[x]:multipleBirthBoolean | 0..1 | boolean | Whether patient is part of a multiple birth | |||||
multipleBirth[x]:multipleBirthInteger | 0..1 | integer | Whether patient is part of a multiple birth | |||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
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 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
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): Use of contact point. | ||||
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 | C | 0..1 | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. 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 | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
street | 0..1 | string | Name of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
streetNumber | 0..1 | string | Number of the street URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
floorDoorNumber | 0..1 | string | Floor and/or door number URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |||||
additionalInformation | 0..1 | string | Additional Information URL: http://hl7.at/fhir/HL7ATCoreProfiles/4.0.1/StructureDefinition/at-core-ext-address-additionalInformation | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
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) | ||||
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 | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 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.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.extension:citizenship.extension:code.value[x] | extensible | ELGAVSCountryCodes (a valid code from HL7® AT® Core ISO 3166-1 alpha 3 Code System) | ||||
Patient.identifier:socialSecurityNumber.use | required | IdentifierUse | ||||
Patient.identifier:socialSecurityNumber.type | extensible | Identifier Type Codes | ||||
Patient.identifier:socialSecurityNumber.assigner.type | extensible | ResourceType | ||||
Patient.identifier:bPK.use | required | IdentifierUse | ||||
Patient.identifier:bPK.type | extensible | Identifier Type Codes | ||||
Patient.identifier:bPK.assigner.type | extensible | ResourceType | ||||
Patient.identifier:localPatientId.use | required | IdentifierUse | ||||
Patient.identifier:localPatientId.type | extensible | Identifier Type Codes | ||||
Patient.name.use | required | NameUse | ||||
Patient.telecom.system | required | ContactPointSystem | ||||
Patient.telecom.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.address.use | required | AddressUse | ||||
Patient.address.type | required | AddressType | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.name.use | required | NameUse | ||||
Patient.contact.telecom.system | required | ContactPointSystem | ||||
Patient.contact.telecom.use | required | ContactPointUse | ||||
Patient.contact.address.use | required | AddressUse | ||||
Patient.contact.address.type | required | AddressType | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |