Estonian Base Implementation Guide
1.0.0 - ballot
Estonian Base Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
Official URL: https://fhir.ee/StructureDefinition/ee-patient | Version: 1.0.0 | |||
Draft as of 2023-05-29 | Computable Name: EEBasePatient |
Patient is a FHIR resource intended for documenting demographical and/or administrative information about the individual on the receiving end of healthcare services. In context of Estonian healthcare data exchange, the patient MUST be identifiable by Person Identity System.
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 | 0..* | Patient | Information about an individual or animal receiving health care services | |
identifier | S | 1..* | Identifier | An identifier for this patient |
system | 0..1 | uri | The namespace for the identifier value Binding: Person Identity System (extensible) | |
active | S | 1..1 | boolean | Whether this patient's record is in active use |
Slices for name | S | 0..* | HumanName | Patient name Slice: Unordered, Open by value:use |
name:All Slices | Content/Rules for all slices | |||
use | S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
text | S | 0..1 | string | Text representation of the full name |
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
name:official | S | 0..1 | HumanName | Ametlik nimi |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
family | 1..1 | string | Perekonnanimi | |
given | 1..1 | string | Eesnimi | |
prefix | S | 0..1 | string | Parts that come before the name |
period | S | 0..1 | Period | Time period when name was/is in use |
name:nickname | S | 0..1 | HumanName | Tundmatu või anonüümse patsiendi nimi |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: nickname | |
text | 1..1 | string | Tundmatu patsiendi hüüdnimi | |
family | 0..0 | |||
given | 0..0 | |||
prefix | 0..0 | |||
suffix | 0..0 | |||
telecom | S | 0..* | ContactPoint | A contact detail for the individual |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
period | S | 0..1 | Period | Time period when the contact point was/is in use |
gender | S | 0..1 | code | male | female | other | unknown Binding: Administrative Gender (required) |
birthDate | S | 0..1 | date | The date of birth for the individual |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthTime | S | 0..1 | dateTime | Sünniaeg URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
value[x] | S | 1..1 | dateTime | Value of extension |
age | 0..1 | Age | Vanus URL: https://fhir.ee/StructureDefinition/ee-patient-age | |
accuracyIndicator | 0..1 | Coding | Kuupäeva täpsuse indikaator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
deceased[x] | S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
accuracyIndicator | 0..1 | Coding | Date accuracy indicator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
address | S | 0..* | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
contact | ||||
address | 0..1 | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
organization | 0..1 | Reference(EEBase Organization) | Organization that is associated with the contact | |
generalPractitioner | S | 0..* | Reference(EEBase Practitioner | EEBase PractitionerRole) | Patient's nominated primary care provider |
managingOrganization | 0..1 | Reference(EEBase Organization) | Organization that is the custodian of the patient record | |
link | S | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
other | 1..1 | Reference(EEBase Patient | EEBase RelatedPerson) | The other patient or related person resource that the link refers to | |
Documentation for this format |
Path | Conformance | ValueSet |
Patient.identifier.system | extensible | EEBasePatientIdentity |
Patient.gender | required | EEBaseAdministrativeGender |
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 |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | An identifier for this patient |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 0..1 | uri | The namespace for the identifier value Binding: Person Identity System (extensible) Example General: http://www.acme.com/identifiers/patient |
active | ?!SΣ | 1..1 | boolean | Whether this patient's record is in active use |
Slices for name | SΣ | 0..* | HumanName | Patient name Slice: Unordered, Open by value:use |
name:All Slices | Content/Rules for all slices | |||
use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 0..1 | string | Text representation of the full name |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 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 |
name:official | SΣ | 0..1 | HumanName | Ametlik nimi |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
family | Σ | 1..1 | string | Perekonnanimi |
given | Σ | 1..1 | string | Eesnimi This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
period | SΣ | 0..1 | Period | Time period when name was/is in use |
name:nickname | SΣ | 0..1 | HumanName | Tundmatu või anonüümse patsiendi nimi |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: nickname |
text | Σ | 1..1 | string | Tundmatu patsiendi hüüdnimi |
telecom | SΣ | 0..* | 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. |
value | SΣC | 1..1 | string | The actual contact point details |
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
period | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: Administrative Gender (required) |
birthDate | SΣ | 0..1 | date | The date of birth for the individual |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthTime | S | 0..1 | dateTime | Sünniaeg URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |
value[x] | S | 1..1 | dateTime | Value of extension |
age | 0..1 | Age | Vanus URL: https://fhir.ee/StructureDefinition/ee-patient-age | |
accuracyIndicator | 0..1 | Coding | Kuupäeva täpsuse indikaator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not | |
deceased[x]:All Types | Content/Rules for all Types | |||
accuracyIndicator | 0..1 | Coding | Date accuracy indicator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | S | 0..* | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
generalPractitioner | S | 0..* | Reference(EEBase Practitioner | EEBase PractitionerRole) | Patient's nominated primary care provider |
managingOrganization | Σ | 0..1 | Reference(EEBase Organization) | Organization that is the custodian of the patient record |
link | ?!SΣ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(EEBase Patient | EEBase 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, or Patient/RelatedPerson when using the seealso code |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Patient.identifier.use | required | IdentifierUse |
Patient.identifier.system | extensible | EEBasePatientIdentity |
Patient.name.use | required | NameUse |
Patient.name:official.use | required | Fixed Value: official |
Patient.name:nickname.use | required | Fixed Value: nickname |
Patient.telecom.system | required | ContactPointSystem |
Patient.telecom.use | required | ContactPointUse |
Patient.gender | required | EEBaseAdministrativeGender |
Patient.link.type | required | LinkType |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
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: AllLanguages (required): IETF language tag for a human language | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | An identifier for this patient |
id | 0..1 | id | 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Binding: Person Identity System (extensible) Example General: http://www.acme.com/identifiers/patient |
value | ΣC | 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 | SΣ | 0..* | HumanName | Patient name Slice: Unordered, Open by value:use |
name:All Slices | Content/Rules for all slices | |||
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 0..1 | string | Text representation of the full name |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 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 |
name:official | SΣ | 0..1 | HumanName | Ametlik nimi |
id | 0..1 | id | 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. Fixed Value: official |
text | Σ | 0..1 | string | Text representation of the full name |
family | Σ | 1..1 | string | Perekonnanimi |
given | Σ | 1..1 | string | Eesnimi This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..1 | 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 | SΣ | 0..1 | Period | Time period when name was/is in use |
name:nickname | SΣ | 0..1 | HumanName | Tundmatu või anonüümse patsiendi nimi |
id | 0..1 | id | 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. Fixed Value: nickname |
text | Σ | 1..1 | string | Tundmatu patsiendi hüüdnimi |
period | Σ | 0..1 | Period | Time period when name was/is in use |
telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual |
id | 0..1 | id | 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ΣC | 1..1 | string | The actual contact point details |
use | ?!SΣ | 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 | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: Administrative Gender (required) |
birthDate | SΣ | 0..1 | date | The date of birth for the individual |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthTime | S | 0..1 | dateTime | Sünniaeg URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |
value[x] | S | 1..1 | dateTime | Value of extension |
age | 0..1 | Age | Vanus URL: https://fhir.ee/StructureDefinition/ee-patient-age | |
accuracyIndicator | 0..1 | Coding | Kuupäeva täpsuse indikaator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
value | 0..1 | date | Primitive value for date | |
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not | |
deceased[x]:All Types | Content/Rules for all Types | |||
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
accuracyIndicator | 0..1 | Coding | Date accuracy indicator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | S | 0..* | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (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 | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
name | C | 0..1 | HumanName | A name associated with the contact person |
telecom | C | 0..* | ContactPoint | A contact detail for the person |
address | 0..1 | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
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(EEBase 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: AllLanguages (required): IETF language tag for a human language | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | S | 0..* | Reference(EEBase Practitioner | EEBase PractitionerRole) | Patient's nominated primary care provider |
managingOrganization | Σ | 0..1 | Reference(EEBase Organization) | Organization that is the custodian of the patient record |
link | ?!SΣ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
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(EEBase Patient | EEBase 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, or Patient/RelatedPerson when using the seealso code |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Patient.language | required | AllLanguages |
Patient.identifier.use | required | IdentifierUse |
Patient.identifier.type | extensible | IdentifierTypeCodes |
Patient.identifier.system | extensible | EEBasePatientIdentity |
Patient.name.use | required | NameUse |
Patient.name:official.use | required | Fixed Value: official |
Patient.name:nickname.use | required | Fixed Value: nickname |
Patient.telecom.system | required | ContactPointSystem |
Patient.telecom.use | required | ContactPointUse |
Patient.gender | required | EEBaseAdministrativeGender |
Patient.maritalStatus | extensible | MaritalStatusCodes |
Patient.contact.relationship | extensible | PatientContactRelationship |
Patient.contact.gender | required | AdministrativeGender |
Patient.communication.language | required | AllLanguages |
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
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: 2 elements (6 nested mandatory elements)
Must-Support: 24 elements
Fixed Value: 2 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
identifier | S | 1..* | Identifier | An identifier for this patient |
system | 0..1 | uri | The namespace for the identifier value Binding: Person Identity System (extensible) | |
active | S | 1..1 | boolean | Whether this patient's record is in active use |
Slices for name | S | 0..* | HumanName | Patient name Slice: Unordered, Open by value:use |
name:All Slices | Content/Rules for all slices | |||
use | S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
text | S | 0..1 | string | Text representation of the full name |
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
name:official | S | 0..1 | HumanName | Ametlik nimi |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
family | 1..1 | string | Perekonnanimi | |
given | 1..1 | string | Eesnimi | |
prefix | S | 0..1 | string | Parts that come before the name |
period | S | 0..1 | Period | Time period when name was/is in use |
name:nickname | S | 0..1 | HumanName | Tundmatu või anonüümse patsiendi nimi |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: nickname | |
text | 1..1 | string | Tundmatu patsiendi hüüdnimi | |
family | 0..0 | |||
given | 0..0 | |||
prefix | 0..0 | |||
suffix | 0..0 | |||
telecom | S | 0..* | ContactPoint | A contact detail for the individual |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
period | S | 0..1 | Period | Time period when the contact point was/is in use |
gender | S | 0..1 | code | male | female | other | unknown Binding: Administrative Gender (required) |
birthDate | S | 0..1 | date | The date of birth for the individual |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthTime | S | 0..1 | dateTime | Sünniaeg URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
value[x] | S | 1..1 | dateTime | Value of extension |
age | 0..1 | Age | Vanus URL: https://fhir.ee/StructureDefinition/ee-patient-age | |
accuracyIndicator | 0..1 | Coding | Kuupäeva täpsuse indikaator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
deceased[x] | S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
accuracyIndicator | 0..1 | Coding | Date accuracy indicator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
address | S | 0..* | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
contact | ||||
address | 0..1 | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
organization | 0..1 | Reference(EEBase Organization) | Organization that is associated with the contact | |
generalPractitioner | S | 0..* | Reference(EEBase Practitioner | EEBase PractitionerRole) | Patient's nominated primary care provider |
managingOrganization | 0..1 | Reference(EEBase Organization) | Organization that is the custodian of the patient record | |
link | S | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
other | 1..1 | Reference(EEBase Patient | EEBase RelatedPerson) | The other patient or related person resource that the link refers to | |
Documentation for this format |
Path | Conformance | ValueSet |
Patient.identifier.system | extensible | EEBasePatientIdentity |
Patient.gender | required | EEBaseAdministrativeGender |
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 |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | An identifier for this patient |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 0..1 | uri | The namespace for the identifier value Binding: Person Identity System (extensible) Example General: http://www.acme.com/identifiers/patient |
active | ?!SΣ | 1..1 | boolean | Whether this patient's record is in active use |
Slices for name | SΣ | 0..* | HumanName | Patient name Slice: Unordered, Open by value:use |
name:All Slices | Content/Rules for all slices | |||
use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 0..1 | string | Text representation of the full name |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 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 |
name:official | SΣ | 0..1 | HumanName | Ametlik nimi |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
family | Σ | 1..1 | string | Perekonnanimi |
given | Σ | 1..1 | string | Eesnimi This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
period | SΣ | 0..1 | Period | Time period when name was/is in use |
name:nickname | SΣ | 0..1 | HumanName | Tundmatu või anonüümse patsiendi nimi |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: nickname |
text | Σ | 1..1 | string | Tundmatu patsiendi hüüdnimi |
telecom | SΣ | 0..* | 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. |
value | SΣC | 1..1 | string | The actual contact point details |
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
period | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: Administrative Gender (required) |
birthDate | SΣ | 0..1 | date | The date of birth for the individual |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthTime | S | 0..1 | dateTime | Sünniaeg URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |
value[x] | S | 1..1 | dateTime | Value of extension |
age | 0..1 | Age | Vanus URL: https://fhir.ee/StructureDefinition/ee-patient-age | |
accuracyIndicator | 0..1 | Coding | Kuupäeva täpsuse indikaator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not | |
deceased[x]:All Types | Content/Rules for all Types | |||
accuracyIndicator | 0..1 | Coding | Date accuracy indicator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | S | 0..* | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
generalPractitioner | S | 0..* | Reference(EEBase Practitioner | EEBase PractitionerRole) | Patient's nominated primary care provider |
managingOrganization | Σ | 0..1 | Reference(EEBase Organization) | Organization that is the custodian of the patient record |
link | ?!SΣ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(EEBase Patient | EEBase 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, or Patient/RelatedPerson when using the seealso code |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Patient.identifier.use | required | IdentifierUse |
Patient.identifier.system | extensible | EEBasePatientIdentity |
Patient.name.use | required | NameUse |
Patient.name:official.use | required | Fixed Value: official |
Patient.name:nickname.use | required | Fixed Value: nickname |
Patient.telecom.system | required | ContactPointSystem |
Patient.telecom.use | required | ContactPointUse |
Patient.gender | required | EEBaseAdministrativeGender |
Patient.link.type | required | LinkType |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
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: AllLanguages (required): IETF language tag for a human language | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | An identifier for this patient |
id | 0..1 | id | 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Binding: Person Identity System (extensible) Example General: http://www.acme.com/identifiers/patient |
value | ΣC | 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 | SΣ | 0..* | HumanName | Patient name Slice: Unordered, Open by value:use |
name:All Slices | Content/Rules for all slices | |||
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 0..1 | string | Text representation of the full name |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 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 |
name:official | SΣ | 0..1 | HumanName | Ametlik nimi |
id | 0..1 | id | 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. Fixed Value: official |
text | Σ | 0..1 | string | Text representation of the full name |
family | Σ | 1..1 | string | Perekonnanimi |
given | Σ | 1..1 | string | Eesnimi This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..1 | 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 | SΣ | 0..1 | Period | Time period when name was/is in use |
name:nickname | SΣ | 0..1 | HumanName | Tundmatu või anonüümse patsiendi nimi |
id | 0..1 | id | 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. Fixed Value: nickname |
text | Σ | 1..1 | string | Tundmatu patsiendi hüüdnimi |
period | Σ | 0..1 | Period | Time period when name was/is in use |
telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual |
id | 0..1 | id | 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ΣC | 1..1 | string | The actual contact point details |
use | ?!SΣ | 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 | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: Administrative Gender (required) |
birthDate | SΣ | 0..1 | date | The date of birth for the individual |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthTime | S | 0..1 | dateTime | Sünniaeg URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |
value[x] | S | 1..1 | dateTime | Value of extension |
age | 0..1 | Age | Vanus URL: https://fhir.ee/StructureDefinition/ee-patient-age | |
accuracyIndicator | 0..1 | Coding | Kuupäeva täpsuse indikaator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
value | 0..1 | date | Primitive value for date | |
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not | |
deceased[x]:All Types | Content/Rules for all Types | |||
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
accuracyIndicator | 0..1 | Coding | Date accuracy indicator URL: https://fhir.ee/StructureDefinition/ee-date-accuracy-indicator Binding: Date Accuracy Indicator (required): Date accuracy coding | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | S | 0..* | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (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 | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
name | C | 0..1 | HumanName | A name associated with the contact person |
telecom | C | 0..* | ContactPoint | A contact detail for the person |
address | 0..1 | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
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(EEBase 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: AllLanguages (required): IETF language tag for a human language | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | S | 0..* | Reference(EEBase Practitioner | EEBase PractitionerRole) | Patient's nominated primary care provider |
managingOrganization | Σ | 0..1 | Reference(EEBase Organization) | Organization that is the custodian of the patient record |
link | ?!SΣ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
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(EEBase Patient | EEBase 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, or Patient/RelatedPerson when using the seealso code |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Patient.language | required | AllLanguages |
Patient.identifier.use | required | IdentifierUse |
Patient.identifier.type | extensible | IdentifierTypeCodes |
Patient.identifier.system | extensible | EEBasePatientIdentity |
Patient.name.use | required | NameUse |
Patient.name:official.use | required | Fixed Value: official |
Patient.name:nickname.use | required | Fixed Value: nickname |
Patient.telecom.system | required | ContactPointSystem |
Patient.telecom.use | required | ContactPointUse |
Patient.gender | required | EEBaseAdministrativeGender |
Patient.maritalStatus | extensible | MaritalStatusCodes |
Patient.contact.relationship | extensible | PatientContactRelationship |
Patient.contact.gender | required | AdministrativeGender |
Patient.communication.language | required | AllLanguages |
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
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: 2 elements (6 nested mandatory elements)
Must-Support: 24 elements
Fixed Value: 2 elements
Prohibited: 4 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