0.1.4 - draft
NabotoImplementationGuide - Local Development build (v0.1.4). See the Directory of published versions
Defining URL: | http://fhir.naboto.com/StructureDefinition/naboto-patient |
Version: | 0.1.4 |
Name: | NabotoPatient |
Title: | Naboto Patient Profile |
Status: | Active as of 2022-11-03 01:30:17+0000 |
Definition: | Naboto Profile for patient data. The Naboto Patient is based upon the HL7ATCorePatient Profile. |
Publisher: | Naboto Software GmbH |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://fhir.naboto.com/StructureDefinition/naboto-patient
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HL7ATCorePatient
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 5 elements
Fixed Value: 3 elements
Prohibited: 13 elements
Slices
This structure defines the following Slices:
This structure is derived from HL7ATCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | Information about an individual or animal receiving health care services | |
language | 0..0 | |||
contained | 0..0 | |||
extension:citizenship | 0..0 | |||
extension:PatientReligion | 0..0 | |||
active | S | 1..1 | boolean | Whether this patient's record is in active use |
Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | |
name:usualName | S | 1..1 | HumanName | A name associated with the patient |
use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: usual | |
Slices for telecom | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | |
telecom:email | S | 0..1 | ContactPoint | A contact detail for the individual |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
telecom:sms | S | 0..1 | ContactPoint | A contact detail for the individual |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: sms | |
gender | S | 1..1 | code | male | female | other | unknown |
deceased[x] | 0..0 | |||
maritalStatus | 0..0 | |||
multipleBirth[x] | 0..0 | |||
photo | 0..0 | |||
contact | 0..0 | |||
communication | 0..0 | |||
generalPractitioner | 0..0 | |||
managingOrganization | 0..0 | |||
link | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | 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 |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
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 | ?!SΣ | 1..1 | boolean | Whether this patient's record is in active use |
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
name:usualName | SΣ | 1..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 | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual |
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 |
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system |
telecom:email | SΣ | 0..1 | 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 | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
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 |
telecom:sms | SΣ | 0..1 | 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 | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: sms |
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 | SΣ | 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 |
address | C | 0..* | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | Information about an individual or animal receiving health care services | |
active | ?!Σ | 1..1 | boolean | Whether this patient's record is in active use |
name:usualName | Σ | 1..1 | HumanName | A name associated with the patient |
telecom:email | Σ | 0..1 | ContactPoint | A contact detail for the individual |
telecom:sms | Σ | 0..1 | ContactPoint | A contact detail for the individual |
gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
Documentation for this format |
This structure is derived from HL7ATCorePatient
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 5 elements
Fixed Value: 3 elements
Prohibited: 13 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from HL7ATCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | Information about an individual or animal receiving health care services | |
language | 0..0 | |||
contained | 0..0 | |||
extension:citizenship | 0..0 | |||
extension:PatientReligion | 0..0 | |||
active | S | 1..1 | boolean | Whether this patient's record is in active use |
Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | |
name:usualName | S | 1..1 | HumanName | A name associated with the patient |
use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: usual | |
Slices for telecom | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | |
telecom:email | S | 0..1 | ContactPoint | A contact detail for the individual |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
telecom:sms | S | 0..1 | ContactPoint | A contact detail for the individual |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: sms | |
gender | S | 1..1 | code | male | female | other | unknown |
deceased[x] | 0..0 | |||
maritalStatus | 0..0 | |||
multipleBirth[x] | 0..0 | |||
photo | 0..0 | |||
contact | 0..0 | |||
communication | 0..0 | |||
generalPractitioner | 0..0 | |||
managingOrganization | 0..0 | |||
link | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | HL7ATCorePatient | 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 |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
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 | ?!SΣ | 1..1 | boolean | Whether this patient's record is in active use |
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
name:usualName | SΣ | 1..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 | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual |
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 |
Slices for telecom | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system |
telecom:email | SΣ | 0..1 | 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 | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
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 |
telecom:sms | SΣ | 0..1 | 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 | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: sms |
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 | SΣ | 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 |
address | C | 0..* | HL7ATCoreAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code | ||||
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:usualName.use | required | Fixed Value: usual | ||||
Patient.telecom:email.system | required | Fixed Value: email | ||||
Patient.telecom:email.use | required | ContactPointUse | ||||
Patient.telecom:sms.system | required | Fixed Value: sms | ||||
Patient.telecom:sms.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
at-addr-1 | error | Patient.address, Patient.contact.address | If the extension for street name is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()) | |
at-addr-2 | error | Patient.address, Patient.contact.address | If the extension for street number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()) | |
at-addr-3 | error | Patient.address, Patient.contact.address | If the extension for floor/door number is used then the value for line must not be empty : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()) | |
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() |