ERA FHIR specification
1.0.0 - draft
ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient | Version: 1.0.0 | |||
| Draft as of 2026-10-28 | Computable Name: KVPPatient | |||
Kysely- ja välityspalvelussa käytettävä Patient-profiili. Henkilö, jota välitettävä asiakirja koskee.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | KantaPatient | Välitettävään asiakirjaan liittyvän asiakkaan tiedot. Constraints: KVP-PAT-1, KVP-PAT-2, KVP-PAT-3, KVP-PAT-4, KVP-PAT-5 |
![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient (no extensions allowed) | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | Identifier | Asiakkaan yksilöivä tunnus Slice: Unordered, Closed by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | Henkilötunnus | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Henkilötunnuksen nimiavaruus Fixed Value: urn:oid:1.2.246.21 (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | Henkilötunnus Example General: 123456 | |
![]() ![]() ![]() |
0..1 | Identifier | Tilapäinen yksilöintitunnus | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: temp (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Käytetty nimiavaruus Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
1..1 | string | Tilapäinen yksilöintitunnus Example General: 123456 | |
![]() ![]() |
0..1 | HumanName | Asiakkaan nimitiedot | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | Asiakkaan sukunimi | |
![]() ![]() ![]() |
1..4 | string | Asiakkaan etunimet This repeating element order: Given Names appear in the correct order for presenting the name | |
![]() ![]() |
0..1 | date | Asiakkaan syntymäaika | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:PIC.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:temp.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:old.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| KVP-PAT-1 | error | Patient | Syntymäaika pakollinen, kun potilaan tunnuksena tilapäinen tunnus. |
Patient.identifier.where(use='temp').exists() implies Patient.birthDate.exists()
|
| KVP-PAT-2 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').exists() implies Patient.identifier.where(use='temp').empty()
|
| KVP-PAT-3 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').empty() implies Patient.identifier.where(use='temp').exists()
|
| KVP-PAT-4 | error | Patient | Syntymäpäivä annettava muodossa yyyy-mm-dd |
Patient.birthDate.exists() implies Patient.birthDate.toString().length()=10
|
| KVP-PAT-5 | error | Patient | Asiakkaan tilapäinen yksilöintitunnus (Patient.identifier) ylittää sallitun maksimipituuden. |
Patient.identifier.where(use='temp').exists() implies Patient.identifier.where(use='temp').system.length()+Patient.identifier.where(use='temp').value.length() < 125
|
| 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()
|
This structure is derived from KantaPatient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | KantaPatient | Välitettävään asiakirjaan liittyvän asiakkaan tiedot. Constraints: KVP-PAT-1, KVP-PAT-2, KVP-PAT-3, KVP-PAT-4, KVP-PAT-5 |
![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient (no extensions allowed) | |
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Language of the resource content | ||
![]() ![]() |
0..0 | Text summary of the resource, for human interpretation | ||
![]() ![]() |
1..* | Identifier | Asiakkaan yksilöivä tunnus | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Identifier | Henkilötunnus | |
![]() ![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | Henkilötunnuksen nimiavaruus | |
![]() ![]() ![]() ![]() |
1..1 | string | Henkilötunnus | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..1 | Identifier | Tilapäinen yksilöintitunnus | |
![]() ![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | Käytetty nimiavaruus | |
![]() ![]() ![]() ![]() |
1..1 | string | Tilapäinen yksilöintitunnus | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..0 | Asiakkaan aiempi yksilöivä tunnus | ||
![]() ![]() |
0..0 | Whether this patient's record is in active use | ||
![]() ![]() |
0..1 | HumanName | Asiakkaan nimitiedot | |
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() |
0..0 | Text representation of the full name | ||
![]() ![]() ![]() |
1..1 | string | Asiakkaan sukunimi | |
![]() ![]() ![]() |
1..4 | string | Asiakkaan etunimet | |
![]() ![]() ![]() |
0..0 | Parts that come before the name | ||
![]() ![]() ![]() |
0..0 | Parts that come after the name | ||
![]() ![]() ![]() |
0..0 | Time period when name was/is in use | ||
![]() ![]() |
0..0 | A contact detail for the individual | ||
![]() ![]() |
0..0 | male | female | other | unknown | ||
![]() ![]() |
0..1 | date | Asiakkaan syntymäaika | |
![]() ![]() |
0..0 | Indicates if the individual is deceased or not | ||
![]() ![]() |
0..0 | An address for the individual | ||
![]() ![]() |
0..0 | Marital (civil) status of a patient | ||
![]() ![]() |
0..0 | Whether patient is part of a multiple birth | ||
![]() ![]() |
0..0 | Image of the patient | ||
![]() ![]() |
0..0 | Yhteyshenkilön yhteystiedot | ||
![]() ![]() |
0..0 | Asiakkaan äidinkieli | ||
![]() ![]() |
0..0 | Patient's nominated primary care provider | ||
![]() ![]() |
0..0 | Organization that is the custodian of the patient record | ||
![]() ![]() |
0..0 | Link to another patient resource that concerns the same actual person | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| KVP-PAT-1 | error | Patient | Syntymäaika pakollinen, kun potilaan tunnuksena tilapäinen tunnus. |
Patient.identifier.where(use='temp').exists() implies Patient.birthDate.exists()
|
| KVP-PAT-2 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').exists() implies Patient.identifier.where(use='temp').empty()
|
| KVP-PAT-3 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').empty() implies Patient.identifier.where(use='temp').exists()
|
| KVP-PAT-4 | error | Patient | Syntymäpäivä annettava muodossa yyyy-mm-dd |
Patient.birthDate.exists() implies Patient.birthDate.toString().length()=10
|
| KVP-PAT-5 | error | Patient | Asiakkaan tilapäinen yksilöintitunnus (Patient.identifier) ylittää sallitun maksimipituuden. |
Patient.identifier.where(use='temp').exists() implies Patient.identifier.where(use='temp').system.length()+Patient.identifier.where(use='temp').value.length() < 125
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | KantaPatient | Välitettävään asiakirjaan liittyvän asiakkaan tiedot. Constraints: KVP-PAT-1, KVP-PAT-2, KVP-PAT-3, KVP-PAT-4, KVP-PAT-5 |
![]() ![]() |
0..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 | |
![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient (no extensions allowed) | |
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
![]() ![]() ![]() |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | Identifier | Asiakkaan yksilöivä tunnus Slice: Unordered, Closed by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | Henkilötunnus | |
![]() ![]() ![]() ![]() |
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 . Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Henkilötunnuksen nimiavaruus Fixed Value: urn:oid:1.2.246.21 (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | Henkilötunnus Example General: 123456 | |
![]() ![]() ![]() |
0..1 | Identifier | Tilapäinen yksilöintitunnus | |
![]() ![]() ![]() ![]() |
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 . Fixed Value: temp (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Käytetty nimiavaruus Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
1..1 | string | Tilapäinen yksilöintitunnus Example General: 123456 | |
![]() ![]() |
0..1 | HumanName | Asiakkaan nimitiedot | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | Asiakkaan sukunimi | |
![]() ![]() ![]() |
1..4 | string | Asiakkaan etunimet This repeating element order: Given Names appear in the correct order for presenting the name | |
![]() ![]() |
0..1 | date | Asiakkaan syntymäaika | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Patient.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Patient.identifier:PIC.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:temp.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:old.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| KVP-PAT-1 | error | Patient | Syntymäaika pakollinen, kun potilaan tunnuksena tilapäinen tunnus. |
Patient.identifier.where(use='temp').exists() implies Patient.birthDate.exists()
|
| KVP-PAT-2 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').exists() implies Patient.identifier.where(use='temp').empty()
|
| KVP-PAT-3 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').empty() implies Patient.identifier.where(use='temp').exists()
|
| KVP-PAT-4 | error | Patient | Syntymäpäivä annettava muodossa yyyy-mm-dd |
Patient.birthDate.exists() implies Patient.birthDate.toString().length()=10
|
| KVP-PAT-5 | error | Patient | Asiakkaan tilapäinen yksilöintitunnus (Patient.identifier) ylittää sallitun maksimipituuden. |
Patient.identifier.where(use='temp').exists() implies Patient.identifier.where(use='temp').system.length()+Patient.identifier.where(use='temp').value.length() < 125
|
| 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()
|
This structure is derived from KantaPatient
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | KantaPatient | Välitettävään asiakirjaan liittyvän asiakkaan tiedot. Constraints: KVP-PAT-1, KVP-PAT-2, KVP-PAT-3, KVP-PAT-4, KVP-PAT-5 |
![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient (no extensions allowed) | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | Identifier | Asiakkaan yksilöivä tunnus Slice: Unordered, Closed by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | Henkilötunnus | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Henkilötunnuksen nimiavaruus Fixed Value: urn:oid:1.2.246.21 (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | Henkilötunnus Example General: 123456 | |
![]() ![]() ![]() |
0..1 | Identifier | Tilapäinen yksilöintitunnus | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: temp (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Käytetty nimiavaruus Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
1..1 | string | Tilapäinen yksilöintitunnus Example General: 123456 | |
![]() ![]() |
0..1 | HumanName | Asiakkaan nimitiedot | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | Asiakkaan sukunimi | |
![]() ![]() ![]() |
1..4 | string | Asiakkaan etunimet This repeating element order: Given Names appear in the correct order for presenting the name | |
![]() ![]() |
0..1 | date | Asiakkaan syntymäaika | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:PIC.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:temp.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:old.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| KVP-PAT-1 | error | Patient | Syntymäaika pakollinen, kun potilaan tunnuksena tilapäinen tunnus. |
Patient.identifier.where(use='temp').exists() implies Patient.birthDate.exists()
|
| KVP-PAT-2 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').exists() implies Patient.identifier.where(use='temp').empty()
|
| KVP-PAT-3 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').empty() implies Patient.identifier.where(use='temp').exists()
|
| KVP-PAT-4 | error | Patient | Syntymäpäivä annettava muodossa yyyy-mm-dd |
Patient.birthDate.exists() implies Patient.birthDate.toString().length()=10
|
| KVP-PAT-5 | error | Patient | Asiakkaan tilapäinen yksilöintitunnus (Patient.identifier) ylittää sallitun maksimipituuden. |
Patient.identifier.where(use='temp').exists() implies Patient.identifier.where(use='temp').system.length()+Patient.identifier.where(use='temp').value.length() < 125
|
| 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()
|
Differential View
This structure is derived from KantaPatient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | KantaPatient | Välitettävään asiakirjaan liittyvän asiakkaan tiedot. Constraints: KVP-PAT-1, KVP-PAT-2, KVP-PAT-3, KVP-PAT-4, KVP-PAT-5 |
![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient (no extensions allowed) | |
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Language of the resource content | ||
![]() ![]() |
0..0 | Text summary of the resource, for human interpretation | ||
![]() ![]() |
1..* | Identifier | Asiakkaan yksilöivä tunnus | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Identifier | Henkilötunnus | |
![]() ![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | Henkilötunnuksen nimiavaruus | |
![]() ![]() ![]() ![]() |
1..1 | string | Henkilötunnus | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..1 | Identifier | Tilapäinen yksilöintitunnus | |
![]() ![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | Käytetty nimiavaruus | |
![]() ![]() ![]() ![]() |
1..1 | string | Tilapäinen yksilöintitunnus | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..0 | Asiakkaan aiempi yksilöivä tunnus | ||
![]() ![]() |
0..0 | Whether this patient's record is in active use | ||
![]() ![]() |
0..1 | HumanName | Asiakkaan nimitiedot | |
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() |
0..0 | Text representation of the full name | ||
![]() ![]() ![]() |
1..1 | string | Asiakkaan sukunimi | |
![]() ![]() ![]() |
1..4 | string | Asiakkaan etunimet | |
![]() ![]() ![]() |
0..0 | Parts that come before the name | ||
![]() ![]() ![]() |
0..0 | Parts that come after the name | ||
![]() ![]() ![]() |
0..0 | Time period when name was/is in use | ||
![]() ![]() |
0..0 | A contact detail for the individual | ||
![]() ![]() |
0..0 | male | female | other | unknown | ||
![]() ![]() |
0..1 | date | Asiakkaan syntymäaika | |
![]() ![]() |
0..0 | Indicates if the individual is deceased or not | ||
![]() ![]() |
0..0 | An address for the individual | ||
![]() ![]() |
0..0 | Marital (civil) status of a patient | ||
![]() ![]() |
0..0 | Whether patient is part of a multiple birth | ||
![]() ![]() |
0..0 | Image of the patient | ||
![]() ![]() |
0..0 | Yhteyshenkilön yhteystiedot | ||
![]() ![]() |
0..0 | Asiakkaan äidinkieli | ||
![]() ![]() |
0..0 | Patient's nominated primary care provider | ||
![]() ![]() |
0..0 | Organization that is the custodian of the patient record | ||
![]() ![]() |
0..0 | Link to another patient resource that concerns the same actual person | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| KVP-PAT-1 | error | Patient | Syntymäaika pakollinen, kun potilaan tunnuksena tilapäinen tunnus. |
Patient.identifier.where(use='temp').exists() implies Patient.birthDate.exists()
|
| KVP-PAT-2 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').exists() implies Patient.identifier.where(use='temp').empty()
|
| KVP-PAT-3 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').empty() implies Patient.identifier.where(use='temp').exists()
|
| KVP-PAT-4 | error | Patient | Syntymäpäivä annettava muodossa yyyy-mm-dd |
Patient.birthDate.exists() implies Patient.birthDate.toString().length()=10
|
| KVP-PAT-5 | error | Patient | Asiakkaan tilapäinen yksilöintitunnus (Patient.identifier) ylittää sallitun maksimipituuden. |
Patient.identifier.where(use='temp').exists() implies Patient.identifier.where(use='temp').system.length()+Patient.identifier.where(use='temp').value.length() < 125
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | KantaPatient | Välitettävään asiakirjaan liittyvän asiakkaan tiedot. Constraints: KVP-PAT-1, KVP-PAT-2, KVP-PAT-3, KVP-PAT-4, KVP-PAT-5 |
![]() ![]() |
0..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 | |
![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient (no extensions allowed) | |
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
![]() ![]() ![]() |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | Identifier | Asiakkaan yksilöivä tunnus Slice: Unordered, Closed by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | Henkilötunnus | |
![]() ![]() ![]() ![]() |
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 . Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Henkilötunnuksen nimiavaruus Fixed Value: urn:oid:1.2.246.21 (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | Henkilötunnus Example General: 123456 | |
![]() ![]() ![]() |
0..1 | Identifier | Tilapäinen yksilöintitunnus | |
![]() ![]() ![]() ![]() |
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 . Fixed Value: temp (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Käytetty nimiavaruus Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
1..1 | string | Tilapäinen yksilöintitunnus Example General: 123456 | |
![]() ![]() |
0..1 | HumanName | Asiakkaan nimitiedot | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | string | Asiakkaan sukunimi | |
![]() ![]() ![]() |
1..4 | string | Asiakkaan etunimet This repeating element order: Given Names appear in the correct order for presenting the name | |
![]() ![]() |
0..1 | date | Asiakkaan syntymäaika | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Patient.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Patient.identifier:PIC.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:temp.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:old.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| KVP-PAT-1 | error | Patient | Syntymäaika pakollinen, kun potilaan tunnuksena tilapäinen tunnus. |
Patient.identifier.where(use='temp').exists() implies Patient.birthDate.exists()
|
| KVP-PAT-2 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').exists() implies Patient.identifier.where(use='temp').empty()
|
| KVP-PAT-3 | error | Patient | Potilaan tunnuksena annetaan joko virallinen tai tilapäinen tunnus. |
Patient.identifier.where(use='official').empty() implies Patient.identifier.where(use='temp').exists()
|
| KVP-PAT-4 | error | Patient | Syntymäpäivä annettava muodossa yyyy-mm-dd |
Patient.birthDate.exists() implies Patient.birthDate.toString().length()=10
|
| KVP-PAT-5 | error | Patient | Asiakkaan tilapäinen yksilöintitunnus (Patient.identifier) ylittää sallitun maksimipituuden. |
Patient.identifier.where(use='temp').exists() implies Patient.identifier.where(use='temp').system.length()+Patient.identifier.where(use='temp').value.length() < 125
|
| 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()
|
This structure is derived from KantaPatient
Other representations of profile: CSV, Excel, Schematron