Finnish Base Profiles
1.0.0-rc2 - ballot
Finnish Base Profiles - Local Development build (v1.0.0-rc2). See the Directory of published versions
Official URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-patient | Version: 1.0.0-rc2 | |||
Draft as of 2023-02-20 | Computable Name: FiBasePatient |
This is the Finnish base profile for the Patient resource.
The Finnish Core Patient profile is intended to encapsulate the most common and basic data model of patients in Finnish social and healthcare systems. The profile also defines how to present data defined in Finnish legislation. As such the profile should be usable in most Finnish contexts.
The Finnish Base Profiles specification does its best to confom to the International Patient Access (IPA) specification. All profiles in this implementation guide derive from the IPA profile, if such a profile is available - except this Patient profile. This is due to the IPA specification imposing cardinality restrictions to Patient.name and Patient.identifier. We specifically don't believe the Patient.name should be a mandatory element. The Finnish PHR, for instance, does not include the name of the patient in the Patient resource. This is why the Finnish Base Patient profile derives from the Patient resource of the main FHIR specification. For additional details, please see the issue FHIR-40451 in HL7 International's Jira.
### Identifying information
In the context of Finnish national social and healthcare, the
[defined identifying information](https://yhteistyotilat.fi/wiki08/display/JULPOKY/7+Potilaan+perustiedot)
for a person are
* first (given) name
* family name
* name history
* national person identifier
* temporary identifier
* time of birth
* gender
* time of death.
The unique identifier is the national person identifier.
#### Patient identifier
There are two versions of the national person identifier for people living in Finland.
The [official Personal Identifier Code](https://dvv.fi/en/personal-identity-code) (PIC) is granted
by the Digital And Population Data Services Agency. The `oid` for the official PIC is `1.2.246.21`.
When an official PIC is not known or cannot be used for other reasons, a system may generate a
[Temporary Identifier](https://www.kanta.fi/en/system-developers/test-etiquette#Temporary%20identifier).
The `oid` for the temporary identifier is `1.2.246.10.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | 1..1 | id | Logical id of this artifact | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Information about non-disclosure (turvakielto) SHALL be handled in meta.security. Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Coding | Security Labels applied to this resource | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-Confidentiality | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Coding | Municipality presents the home municipality of the patients. This information is relevant for ex. in billing and listing available healthcare services. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/municipality-code | |
![]() ![]() ![]() | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
![]() ![]() ![]() | 0..* | Identifier | Identifier contains Finnish personal identity code which can be official or temporary. Other identifier may also be included. Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.246.21 | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Coding | Municipality presents the home municipality of the patients. This information is relevant for ex. in billing and listing available healthcare services. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/municipality-code | |
![]() ![]() ![]() | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | Identifier contains Finnish personal identity code which can be official or temporary. Other identifier may also be included. Slice: Unordered, Open by value:use |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.246.21 |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
![]() |
Path | Conformance | ValueSet / Code |
Patient.identifier:PIC.use | required | Pattern: official |
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().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() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() | Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Information about non-disclosure (turvakielto) SHALL be handled in meta.security. Slice: Unordered, Open by value:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-Confidentiality | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. \u0022Needs review by Dr. Jones\u0022. | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | Coding | Municipality presents the home municipality of the patients. This information is relevant for ex. in billing and listing available healthcare services. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/municipality-code | |||||
![]() ![]() ![]() | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Identifier contains Finnish personal identity code which can be official or temporary. Other identifier may also be included. Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.246.21 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() | Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() | 0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet / Code | ||||
Patient.meta.security | extensible | All Security Labels | ||||
Patient.meta.security:non-disclosure | extensible | All Security Labels | ||||
Patient.meta.tag | example | CommonTags | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.identifier:PIC.use | required | Pattern: official | ||||
Patient.identifier:PIC.type | extensible | Identifier Type Codes | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
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: 1 element (2 nested mandatory elements)
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![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | 1..1 | id | Logical id of this artifact | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Information about non-disclosure (turvakielto) SHALL be handled in meta.security. Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Coding | Security Labels applied to this resource | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-Confidentiality | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Coding | Municipality presents the home municipality of the patients. This information is relevant for ex. in billing and listing available healthcare services. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/municipality-code | |
![]() ![]() ![]() | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
![]() ![]() ![]() | 0..* | Identifier | Identifier contains Finnish personal identity code which can be official or temporary. Other identifier may also be included. Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.246.21 | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Coding | Municipality presents the home municipality of the patients. This information is relevant for ex. in billing and listing available healthcare services. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/municipality-code | |
![]() ![]() ![]() | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | Identifier contains Finnish personal identity code which can be official or temporary. Other identifier may also be included. Slice: Unordered, Open by value:use |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.246.21 |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
![]() |
Path | Conformance | ValueSet / Code |
Patient.identifier:PIC.use | required | Pattern: official |
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().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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() | Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Information about non-disclosure (turvakielto) SHALL be handled in meta.security. Slice: Unordered, Open by value:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-Confidentiality | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. \u0022Needs review by Dr. Jones\u0022. | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | Coding | Municipality presents the home municipality of the patients. This information is relevant for ex. in billing and listing available healthcare services. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/municipality-code | |||||
![]() ![]() ![]() | 0..1 | boolean | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Identifier contains Finnish personal identity code which can be official or temporary. Other identifier may also be included. Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.246.21 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() | Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() | 0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet / Code | ||||
Patient.meta.security | extensible | All Security Labels | ||||
Patient.meta.security:non-disclosure | extensible | All Security Labels | ||||
Patient.meta.tag | example | CommonTags | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.identifier:PIC.use | required | Pattern: official | ||||
Patient.identifier:PIC.type | extensible | Identifier Type Codes | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
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: 1 element (2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron