GIIS Implementation Guide
0.1.8 - ci-build
GIIS Implementation Guide, published by CENS. This guide is not an authorized publication; it is the continuous build for version 0.1.8 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cens-chile/giis_fhir_IG/ and changes regularly. See the Directory of published versions
Official URL: https://paho.org/fhir/giis/StructureDefinition/GIISPatient | Version: 0.1.8 | |||
Draft as of 2024-11-05 | Computable Name: GIISPatient |
A patient from GIIS, this one can be either a child or an adult.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | Patient | |||
Slices for extension | 2..5 | Extension | Extension Slice: Unordered, Open by value:url | |
village | 1..1 | Reference(Village) | Extension made for making a patient able to reference a village URL: https://paho.org/fhir/giis/StructureDefinition/giis-village | |
birthplace | 0..1 | CodeableConcept | Extension made for handling the birthplace of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-birthplace Binding: Birthplace (example) | |
community | 0..1 | CodeableConcept | Extension made for handling the community of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-community Binding: Community (example) | |
notes | 0..1 | string | Extension made for being able to add notes to a GIIS patient URL: https://paho.org/fhir/giis/StructureDefinition/giis-patnotes | |
recordCreator | 1..1 | Reference(Practitioner) | Extension made for handling the creator of the patient's record URL: https://paho.org/fhir/giis/StructureDefinition/giis-recordcreator | |
Slices for identifier | S | 0..4 | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
identifier:SystemID | S | 0..1 | Identifier | Identifier assigned to the patient if the country doesn't handle IDs |
system | S | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/SystemID Required Pattern: http://www.giisidentifier.org/ID/SystemID |
value | S | 0..1 | string | Actual value of the ID, usually a number |
identifier:IdentificationNo1 | S | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
system | S | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo1 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo1 |
value | S | 0..1 | string | Actual value of the ID, usually a number |
identifier:IdentificationNo2 | S | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
system | S | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo2 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo2 |
value | S | 0..1 | string | Actual value of the ID, usually a number |
identifier:IdentificationNo3 | S | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
system | S | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo3 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo3 |
value | S | 0..1 | string | Actual value of the ID, usually a number |
name | S | 1..1 | HumanName | A name associated with the patient |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 1..2 | string | Given names (not always 'first'). Includes middle names |
Slices for telecom | S | 0..3 | ContactPoint | Contact detail for the individual Slice: Unordered, Closed by value:system, value:use |
telecom:GIISPhone | S | 0..1 | ContactPoint | A contact detail for the individual |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home |
telecom:GIISMobile | S | 0..1 | ContactPoint | A contact detail for the individual |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: mobile |
telecom:GIISEmail | S | 0..1 | ContactPoint | A contact detail for the individual |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email |
value | S | 1..1 | string | The actual contact point details |
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home |
gender | S | 1..1 | code | Gender MUST be #male OR #female |
birthDate | S | 1..1 | date | The date of birth for the individual |
address | S | 0..1 | Address | An address for the individual |
line | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
contact | S | 0..1 | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
relationship | S | 1..1 | CodeableConcept | The kind of relationship |
coding | ||||
code | S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: N |
name | S | 1..1 | HumanName | A name associated with the contact person |
text | S | 1..1 | string | Full name of the patient's next of kin |
telecom | S | 1..1 | ContactPoint | A contact detail for the person |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 1..1 | string | The actual contact point details |
managingOrganization | S | 1..1 | Reference(HealthFacility) | Organization that is the custodian of the patient record |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..5 | Extension | Extension Slice: Unordered, Open by value:url | |
village | 1..1 | Reference(Village) | Extension made for making a patient able to reference a village URL: https://paho.org/fhir/giis/StructureDefinition/giis-village | |
birthplace | 0..1 | CodeableConcept | Extension made for handling the birthplace of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-birthplace Binding: Birthplace (example) | |
community | 0..1 | CodeableConcept | Extension made for handling the community of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-community Binding: Community (example) | |
notes | 0..1 | string | Extension made for being able to add notes to a GIIS patient URL: https://paho.org/fhir/giis/StructureDefinition/giis-patnotes | |
recordCreator | 1..1 | Reference(Practitioner) | Extension made for handling the creator of the patient's record URL: https://paho.org/fhir/giis/StructureDefinition/giis-recordcreator | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 0..4 | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
identifier:SystemID | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country doesn't handle IDs |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/SystemID Required Pattern: http://www.giisidentifier.org/ID/SystemID |
value | SΣ | 0..1 | string | Actual value of the ID, usually a number Example General: 123456 |
identifier:IdentificationNo1 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo1 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo1 |
value | SΣ | 0..1 | string | Actual value of the ID, usually a number Example General: 123456 |
identifier:IdentificationNo2 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo2 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo2 |
value | SΣ | 0..1 | string | Actual value of the ID, usually a number Example General: 123456 |
identifier:IdentificationNo3 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo3 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo3 |
value | SΣ | 0..1 | string | Actual value of the ID, usually a number Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
name | SΣ | 1..1 | HumanName | A name associated with the patient |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣ | 1..1 | string | Family name (often called 'Surname') |
given | SΣ | 1..2 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
Slices for telecom | SΣ | 0..3 | ContactPoint | Contact detail for the individual Slice: Unordered, Closed by value:system, value:use |
telecom:GIISPhone | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home |
telecom:GIISMobile | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile |
telecom:GIISEmail | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home |
gender | SΣ | 1..1 | code | Gender MUST be #male OR #female Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | SΣ | 1..1 | date | The date of birth for the individual |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | SΣ | 0..1 | Address | An address for the individual |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
contact | SC | 0..1 | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: N |
name | S | 1..1 | HumanName | A name associated with the contact person |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 1..1 | string | Full name of the patient's next of kin |
telecom | S | 1..1 | ContactPoint | A contact detail for the person |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 1..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. |
managingOrganization | SΣ | 1..1 | Reference(HealthFacility) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
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 |
Path | Conformance | ValueSet / Code | URI |
Patient.identifier:SystemID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:IdentificationNo1.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:IdentificationNo2.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:IdentificationNo3.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISPhone.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISPhone.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISMobile.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISMobile.use | required | Pattern: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISEmail.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISEmail.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | |
Patient.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
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 | 2..5 | Extension | Extension Slice: Unordered, Open by value:url | |||||
village | 1..1 | Reference(Village) | Extension made for making a patient able to reference a village URL: https://paho.org/fhir/giis/StructureDefinition/giis-village | |||||
birthplace | 0..1 | CodeableConcept | Extension made for handling the birthplace of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-birthplace Binding: Birthplace (example) | |||||
community | 0..1 | CodeableConcept | Extension made for handling the community of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-community Binding: Community (example) | |||||
notes | 0..1 | string | Extension made for being able to add notes to a GIIS patient URL: https://paho.org/fhir/giis/StructureDefinition/giis-patnotes | |||||
recordCreator | 1..1 | Reference(Practitioner) | Extension made for handling the creator of the patient's record URL: https://paho.org/fhir/giis/StructureDefinition/giis-recordcreator | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 0..4 | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system | ||||
identifier:SystemID | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country doesn't handle IDs | ||||
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. | ||||
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/SystemID Required Pattern: http://www.giisidentifier.org/ID/SystemID | ||||
value | SΣ | 0..1 | string | Actual value of the ID, usually a number 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) | ||||
identifier:IdentificationNo1 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs | ||||
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. | ||||
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo1 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo1 | ||||
value | SΣ | 0..1 | string | Actual value of the ID, usually a number 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) | ||||
identifier:IdentificationNo2 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs | ||||
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. | ||||
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo2 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo2 | ||||
value | SΣ | 0..1 | string | Actual value of the ID, usually a number 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) | ||||
identifier:IdentificationNo3 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs | ||||
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. | ||||
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo3 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo3 | ||||
value | SΣ | 0..1 | string | Actual value of the ID, usually a number 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 | 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 | ?!Σ | 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 | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 1..2 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
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 | SΣ | 0..3 | ContactPoint | Contact detail for the individual Slice: Unordered, Closed by value:system, value:use | ||||
telecom:GIISPhone | 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 | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home | ||||
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:GIISMobile | 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 | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile | ||||
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:GIISEmail | 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 | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home | ||||
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 | Gender MUST be #male OR #female Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 1..1 | date | The date of birth for the individual | ||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | SΣ | 0..1 | Address | An address 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 | |||||
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 | SΣ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | SC | 0..1 | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
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 | S | 1..1 | 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 | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: N | ||||
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 | S | 1..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 | SΣ | 1..1 | string | Full name of the patient's next of kin | ||||
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 | S | 1..1 | 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 | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | SΣ | 1..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 | 0..1 | Address | Address for the contact person | |||||
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 | SΣ | 1..1 | Reference(HealthFacility) | 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 |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier:SystemID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:SystemID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:IdentificationNo1.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:IdentificationNo1.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:IdentificationNo2.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:IdentificationNo2.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:IdentificationNo3.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:IdentificationNo3.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISPhone.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISPhone.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISMobile.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISMobile.use | required | Pattern: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISEmail.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISEmail.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from Patient
Summary
Mandatory: 8 elements(20 nested mandatory elements)
Must-Support: 42 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 | Patient | |||
Slices for extension | 2..5 | Extension | Extension Slice: Unordered, Open by value:url | |
village | 1..1 | Reference(Village) | Extension made for making a patient able to reference a village URL: https://paho.org/fhir/giis/StructureDefinition/giis-village | |
birthplace | 0..1 | CodeableConcept | Extension made for handling the birthplace of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-birthplace Binding: Birthplace (example) | |
community | 0..1 | CodeableConcept | Extension made for handling the community of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-community Binding: Community (example) | |
notes | 0..1 | string | Extension made for being able to add notes to a GIIS patient URL: https://paho.org/fhir/giis/StructureDefinition/giis-patnotes | |
recordCreator | 1..1 | Reference(Practitioner) | Extension made for handling the creator of the patient's record URL: https://paho.org/fhir/giis/StructureDefinition/giis-recordcreator | |
Slices for identifier | S | 0..4 | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
identifier:SystemID | S | 0..1 | Identifier | Identifier assigned to the patient if the country doesn't handle IDs |
system | S | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/SystemID Required Pattern: http://www.giisidentifier.org/ID/SystemID |
value | S | 0..1 | string | Actual value of the ID, usually a number |
identifier:IdentificationNo1 | S | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
system | S | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo1 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo1 |
value | S | 0..1 | string | Actual value of the ID, usually a number |
identifier:IdentificationNo2 | S | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
system | S | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo2 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo2 |
value | S | 0..1 | string | Actual value of the ID, usually a number |
identifier:IdentificationNo3 | S | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
system | S | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo3 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo3 |
value | S | 0..1 | string | Actual value of the ID, usually a number |
name | S | 1..1 | HumanName | A name associated with the patient |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 1..2 | string | Given names (not always 'first'). Includes middle names |
Slices for telecom | S | 0..3 | ContactPoint | Contact detail for the individual Slice: Unordered, Closed by value:system, value:use |
telecom:GIISPhone | S | 0..1 | ContactPoint | A contact detail for the individual |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home |
telecom:GIISMobile | S | 0..1 | ContactPoint | A contact detail for the individual |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: mobile |
telecom:GIISEmail | S | 0..1 | ContactPoint | A contact detail for the individual |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email |
value | S | 1..1 | string | The actual contact point details |
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: home |
gender | S | 1..1 | code | Gender MUST be #male OR #female |
birthDate | S | 1..1 | date | The date of birth for the individual |
address | S | 0..1 | Address | An address for the individual |
line | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
contact | S | 0..1 | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
relationship | S | 1..1 | CodeableConcept | The kind of relationship |
coding | ||||
code | S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: N |
name | S | 1..1 | HumanName | A name associated with the contact person |
text | S | 1..1 | string | Full name of the patient's next of kin |
telecom | S | 1..1 | ContactPoint | A contact detail for the person |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 1..1 | string | The actual contact point details |
managingOrganization | S | 1..1 | Reference(HealthFacility) | Organization that is the custodian of the patient record |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..5 | Extension | Extension Slice: Unordered, Open by value:url | |
village | 1..1 | Reference(Village) | Extension made for making a patient able to reference a village URL: https://paho.org/fhir/giis/StructureDefinition/giis-village | |
birthplace | 0..1 | CodeableConcept | Extension made for handling the birthplace of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-birthplace Binding: Birthplace (example) | |
community | 0..1 | CodeableConcept | Extension made for handling the community of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-community Binding: Community (example) | |
notes | 0..1 | string | Extension made for being able to add notes to a GIIS patient URL: https://paho.org/fhir/giis/StructureDefinition/giis-patnotes | |
recordCreator | 1..1 | Reference(Practitioner) | Extension made for handling the creator of the patient's record URL: https://paho.org/fhir/giis/StructureDefinition/giis-recordcreator | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 0..4 | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system |
identifier:SystemID | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country doesn't handle IDs |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/SystemID Required Pattern: http://www.giisidentifier.org/ID/SystemID |
value | SΣ | 0..1 | string | Actual value of the ID, usually a number Example General: 123456 |
identifier:IdentificationNo1 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo1 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo1 |
value | SΣ | 0..1 | string | Actual value of the ID, usually a number Example General: 123456 |
identifier:IdentificationNo2 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo2 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo2 |
value | SΣ | 0..1 | string | Actual value of the ID, usually a number Example General: 123456 |
identifier:IdentificationNo3 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo3 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo3 |
value | SΣ | 0..1 | string | Actual value of the ID, usually a number Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
name | SΣ | 1..1 | HumanName | A name associated with the patient |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣ | 1..1 | string | Family name (often called 'Surname') |
given | SΣ | 1..2 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
Slices for telecom | SΣ | 0..3 | ContactPoint | Contact detail for the individual Slice: Unordered, Closed by value:system, value:use |
telecom:GIISPhone | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home |
telecom:GIISMobile | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile |
telecom:GIISEmail | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home |
gender | SΣ | 1..1 | code | Gender MUST be #male OR #female Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | SΣ | 1..1 | date | The date of birth for the individual |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | SΣ | 0..1 | Address | An address for the individual |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
contact | SC | 0..1 | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: N |
name | S | 1..1 | HumanName | A name associated with the contact person |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 1..1 | string | Full name of the patient's next of kin |
telecom | S | 1..1 | ContactPoint | A contact detail for the person |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 1..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. |
managingOrganization | SΣ | 1..1 | Reference(HealthFacility) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
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 |
Path | Conformance | ValueSet / Code | URI |
Patient.identifier:SystemID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:IdentificationNo1.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:IdentificationNo2.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.identifier:IdentificationNo3.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISPhone.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISPhone.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISMobile.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISMobile.use | required | Pattern: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISEmail.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.telecom:GIISEmail.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | |
Patient.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
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 | 2..5 | Extension | Extension Slice: Unordered, Open by value:url | |||||
village | 1..1 | Reference(Village) | Extension made for making a patient able to reference a village URL: https://paho.org/fhir/giis/StructureDefinition/giis-village | |||||
birthplace | 0..1 | CodeableConcept | Extension made for handling the birthplace of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-birthplace Binding: Birthplace (example) | |||||
community | 0..1 | CodeableConcept | Extension made for handling the community of a GIIS patient, mainly for searching purposes URL: https://paho.org/fhir/giis/StructureDefinition/giis-community Binding: Community (example) | |||||
notes | 0..1 | string | Extension made for being able to add notes to a GIIS patient URL: https://paho.org/fhir/giis/StructureDefinition/giis-patnotes | |||||
recordCreator | 1..1 | Reference(Practitioner) | Extension made for handling the creator of the patient's record URL: https://paho.org/fhir/giis/StructureDefinition/giis-recordcreator | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 0..4 | Identifier | An identifier for this patient Slice: Unordered, Closed by value:system | ||||
identifier:SystemID | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country doesn't handle IDs | ||||
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. | ||||
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/SystemID Required Pattern: http://www.giisidentifier.org/ID/SystemID | ||||
value | SΣ | 0..1 | string | Actual value of the ID, usually a number 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) | ||||
identifier:IdentificationNo1 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs | ||||
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. | ||||
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo1 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo1 | ||||
value | SΣ | 0..1 | string | Actual value of the ID, usually a number 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) | ||||
identifier:IdentificationNo2 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs | ||||
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. | ||||
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo2 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo2 | ||||
value | SΣ | 0..1 | string | Actual value of the ID, usually a number 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) | ||||
identifier:IdentificationNo3 | SΣ | 0..1 | Identifier | Identifier assigned to the patient if the country does handle IDs | ||||
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. | ||||
system | SΣ | 1..1 | uri | endPoint that will validate this ID. For this one, use: http://www.giisidentifier.org/ID/IdentificationNo3 Required Pattern: http://www.giisidentifier.org/ID/IdentificationNo3 | ||||
value | SΣ | 0..1 | string | Actual value of the ID, usually a number 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 | 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 | ?!Σ | 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 | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 1..2 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
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 | SΣ | 0..3 | ContactPoint | Contact detail for the individual Slice: Unordered, Closed by value:system, value:use | ||||
telecom:GIISPhone | 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 | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home | ||||
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:GIISMobile | 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 | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile | ||||
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:GIISEmail | 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 | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: home | ||||
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 | Gender MUST be #male OR #female Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 1..1 | date | The date of birth for the individual | ||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | SΣ | 0..1 | Address | An address 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 | |||||
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 | SΣ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | SC | 0..1 | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
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 | S | 1..1 | 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 | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: N | ||||
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 | S | 1..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 | SΣ | 1..1 | string | Full name of the patient's next of kin | ||||
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 | S | 1..1 | 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 | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | SΣ | 1..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 | 0..1 | Address | Address for the contact person | |||||
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 | SΣ | 1..1 | Reference(HealthFacility) | 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 |
Path | Conformance | ValueSet / Code | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier:SystemID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:SystemID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:IdentificationNo1.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:IdentificationNo1.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:IdentificationNo2.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:IdentificationNo2.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:IdentificationNo3.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:IdentificationNo3.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISPhone.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISPhone.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISMobile.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISMobile.use | required | Pattern: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISEmail.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:GIISEmail.use | required | Pattern: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from Patient
Summary
Mandatory: 8 elements(20 nested mandatory elements)
Must-Support: 42 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron