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

Resource Profile: KVPPatient - Detailed Descriptions

Draft as of 2026-10-28

Definitions for the KVPPatient resource profile.

See the documentation on how to interpret the contents of this table

0. Patient
Definition

Profiililla ilmoitetaan:

Asiakkaan tiedot, jonka asiakirjaan tehdään välityspyyntö.


Demographics and other administrative information about an individual or animal receiving care or other health-related services.

ShortVälitettävään asiakirjaan liittyvän asiakkaan tiedot.Information about an individual or animal receiving health care services
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesSubjectOfCare Client Resident
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
KVP-PAT-1: Syntymäaika pakollinen, kun potilaan tunnuksena tilapäinen tunnus. (Patient.identifier.where(use='temp').exists() implies Patient.birthDate.exists())
KVP-PAT-2: 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: 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: Syntymäpäivä annettava muodossa yyyy-mm-dd (Patient.birthDate.exists() implies Patient.birthDate.toString().length()=10)
KVP-PAT-5: 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)
2. Patient.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Patient.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.


A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

ShortProfiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control10..1*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "profile" : "https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient"
}
<profile value="https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Patient.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..01
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Patient.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..01
BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Patient.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..01
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Patient.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Patient.identifier
Definition

Asiakkaan yksilöivänä tunnuksena ilmoitetaan henkilötunnus tai tilapäinen yksilöintitunnus.


An identifier for this patient.

ShortAsiakkaan yksilöivä tunnusAn identifier for this patient
NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Requirements

Patients are almost always assigned specific numerical identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • value @ use
  • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

    16. Patient.identifier:PIC
    Slice NamePIC
    Definition

    Henkilötunnus, jolla asiakas on yksilöity.


    An identifier for this patient.

    ShortHenkilötunnusAn identifier for this patient
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1*
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Requirements

    Patients are almost always assigned specific numerical identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Patient.identifier:PIC.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..01
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    20. Patient.identifier:PIC.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control10..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Fixed Value
    {
      "use" : "official"
    }
    <use value="official"/>
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Patient.identifier:PIC.type
    Definition

    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    ShortDescription of identifier
    Comments

    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

    Control0..01
    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows users to make use of identifiers when the identifier system is not known.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Patient.identifier:PIC.system
    Definition

    Henkilötunnuksen nimiavaruutena käytetään urn:oid:1.2.246.21.


    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    ShortHenkilötunnuksen nimiavaruusThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    Fixed Value
    {
      "system" : "urn:oid:1.2.246.21"
    }
    <system value="urn:oid:1.2.246.21"/>
    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Patient.identifier:PIC.value
    Definition

    Asiakkaan henkilötunnus ilman nimiavaruutta.


    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortHenkilötunnusThe value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    ExampleGeneral: 123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Patient.identifier:PIC.period
    Definition

    Time period during which identifier is/was valid for use.

    ShortTime period when id is/was valid for use
    Control0..01
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Patient.identifier:PIC.assigner
    Definition

    Organization that issued/manages the identifier.

    ShortOrganization that issued id (may be just text)
    Comments

    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

    Control0..01
    TypeReference(Organization)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Patient.identifier:temp
    Slice Nametemp
    Definition

    Asiakkaan tilapäinen yksilöintitunnus


    An identifier for this patient.

    ShortTilapäinen yksilöintitunnusAn identifier for this patient
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1*
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Requirements

    Patients are almost always assigned specific numerical identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Patient.identifier:temp.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..01
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    36. Patient.identifier:temp.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control10..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Fixed Value
    {
      "use" : "temp"
    }
    <use value="temp"/>
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. Patient.identifier:temp.type
    Definition

    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    ShortDescription of identifier
    Comments

    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

    Control0..01
    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows users to make use of identifiers when the identifier system is not known.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Patient.identifier:temp.system
    Definition

    Nimiavaruus, jota organisaatio käyttää terveydenhuollon asiakkaiden tilapäisten yksilöivien tunnusten muodostamisessa.

    OIDit terveydenhuollon yksiköiden vastuulla. Ks. tarkempi kuvaus FI Base Patient - Finnish Base Profiles v1.0.0


    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    ShortKäytetty nimiavaruusThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Patient.identifier:temp.value
    Definition

    Asiakkaan tilapäinen yksilöintitunnus ilman käytettävää nimiavaruutta.


    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortTilapäinen yksilöintitunnusThe value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    ExampleGeneral: 123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Patient.identifier:temp.period
    Definition

    Time period during which identifier is/was valid for use.

    ShortTime period when id is/was valid for use
    Control0..01
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Patient.identifier:temp.assigner
    Definition

    Organization that issued/manages the identifier.

    ShortOrganization that issued id (may be just text)
    Comments

    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

    Control0..01
    TypeReference(Organization)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. Patient.identifier:old
    Slice Nameold
    Definition

    Henkilötunnus tai tilapäinen yksilöinitunnus, jolla asiakas on yksilöity aiemmin.


    An identifier for this patient.

    ShortAsiakkaan aiempi yksilöivä tunnusAn identifier for this patient
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..0*
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Requirements

    Patients are almost always assigned specific numerical identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    57. Patient.active
    Definition

    Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

    It is often used to filter patient lists to exclude inactive patients

    Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

    ShortWhether this patient's record is in active use
    Comments

    If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

    Control0..01
    Typeboolean
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be able to mark a patient record as not to be used because it was created in error.

    Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    59. Patient.name
    Definition

    Asiakkaan virallinen nimi.


    A name associated with the individual.

    ShortAsiakkaan nimitiedotA name associated with the patient
    Comments

    A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

    Control0..1*
    TypeHumanName
    Is Modifierfalse
    Summarytrue
    Requirements

    Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    61. Patient.name.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..01
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    63. Patient.name.use
    Definition

    Käytetään arvoa official eli asiakkaan virallista nimeä.


    Identifies the purpose for this name.

    Shortusual | official | temp | nickname | anonymous | old | maiden
    Comments

    Applications can assume that a name is current unless it explicitly says that it is temporary or old.

    Control0..1
    BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

    The use of a human name.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate name for a particular context of use to be selected from among a set of names.

    Fixed Value
    {
      "use" : "official"
    }
    <use value="official"/>
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    65. Patient.name.text
    Definition

    Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

    ShortText representation of the full name
    Comments

    Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

    Control0..01
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    A renderable, unencoded form.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    67. Patient.name.family
    Definition

    Asiakkaan sukunimi


    The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

    ShortAsiakkaan sukunimiFamily name (often called 'Surname')
    Comments

    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate Namessurname
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    69. Patient.name.given
    Definition

    Asiakkaan etunimet virallisessa järjestyksessä


    Given name.

    ShortAsiakkaan etunimetGiven names (not always 'first'). Includes middle names
    Comments

    If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

    Control10..4*
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate Namesfirst name, middle name
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    71. Patient.name.prefix
    Definition

    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

    ShortParts that come before the name
    Control0..0*
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    73. Patient.name.suffix
    Definition

    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

    ShortParts that come after the name
    Control0..0*
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    75. Patient.name.period
    Definition

    Indicates the period of time when this name was valid for the named person.

    ShortTime period when name was/is in use
    Control0..01
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows names to be placed in historical context.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    77. Patient.telecom
    Definition

    A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

    ShortA contact detail for the individual
    Comments

    A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

    Control0..0*
    TypeContactPoint
    Is Modifierfalse
    Summarytrue
    Requirements

    People have (primary) ways to contact them in some way such as phone, email.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    79. Patient.gender
    Definition

    Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

    Shortmale | female | other | unknown
    Comments

    The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

    Control0..01
    BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

    The gender of a person used for administrative purposes.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Needed for identification of the individual, in combination with (at least) name and birth date.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    81. Patient.birthDate
    Definition

    Asiakkaan syntymäaika. Pakollinen, jos asiakkaan tunnisteena käytetty tilapäistä yksilöintitunnusta.


    The date of birth for the individual.

    ShortAsiakkaan syntymäaikaThe date of birth for the individual
    Comments

    At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

    Control0..1
    Typedate
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Age of the individual drives many clinical processes.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    LOINC Code21112-8
    83. Patient.deceased[x]
    Definition

    Indicates if the individual is deceased or not.

    ShortIndicates if the individual is deceased or not
    Comments

    If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

    Control0..01
    TypeChoice of: boolean, dateTime
    Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    85. Patient.address
    Definition

    An address for the individual.

    ShortAn address for the individual
    Comments

    Patient may have multiple addresses with different uses or applicable periods.

    Control0..0*
    TypeAddress
    Is Modifierfalse
    Summarytrue
    Requirements

    May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    87. Patient.maritalStatus
    Definition

    This field contains a patient's most recent marital (civil) status.

    ShortMarital (civil) status of a patient
    Control0..01
    BindingUnless not suitable, these codes SHALL be taken from Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status|4.0.1
    (extensible to http://hl7.org/fhir/ValueSet/marital-status|4.0.1)

    The domestic partnership status of a person.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Requirements

    Most, if not all systems capture it.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    89. Patient.multipleBirth[x]
    Definition

    Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

    ShortWhether patient is part of a multiple birth
    Comments

    Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

    Control0..01
    TypeChoice of: boolean, integer
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Requirements

    For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    91. Patient.photo
    Definition

    Image of the patient.

    ShortImage of the patient
    Comments

    Guidelines:

    • Use id photos, not clinical photos.
    • Limit dimensions to thumbnail.
    • Keep byte count low to ease resource updates.
    Control0..0*
    TypeAttachment
    Is Modifierfalse
    Summaryfalse
    Requirements

    Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    93. Patient.contact
    Definition

    Ajanvaraukseen liittyvän yhteyshenkilön tiedot.


    A contact party (e.g. guardian, partner, friend) for the patient.

    ShortYhteyshenkilön yhteystiedotA contact party (e.g. guardian, partner, friend) for the patient
    Comments

    Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    Need to track people you can contact about the patient.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    pat-1: 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())
    pat-1: 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())
    121. Patient.communication
    Definition

    Kenttään tuotetaan kielikoodiston avulla tieto asiakkaan äidinkielestä.

    Preferred arvoksi annetaan true.


    A language which may be used to communicate with the patient about his or her health.

    ShortAsiakkaan äidinkieliA language which may be used to communicate with the patient about his or her health
    Comments

    If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Requirements

    If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    136. Patient.generalPractitioner
    Definition

    Patient's nominated care provider.

    ShortPatient's nominated primary care provider
    Comments

    This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

    Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

    Control0..0*
    TypeReference(Organization, Practitioner, PractitionerRole)
    Is Modifierfalse
    Summaryfalse
    Alternate NamescareProvider
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    138. Patient.managingOrganization
    Definition

    Organization that is the custodian of the patient record.

    ShortOrganization that is the custodian of the patient record
    Comments

    There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

    Control0..01
    TypeReference(Organization)
    Is Modifierfalse
    Summarytrue
    Requirements

    Need to know who recognizes this patient record, manages and updates it.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    140. Patient.link
    Definition

    Link to another patient resource that concerns the same actual patient.

    ShortLink to another patient resource that concerns the same actual person
    Comments

    There is no assumption that linked patient records have mutual links.

    Control0..0*
    TypeBackboneElement
    Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
    Summarytrue
    Requirements

    There are multiple use cases:

    • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
    • Distribution of patient information across multiple servers.
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    See the documentation on how to interpret the contents of this table

    0. Patient
    Definition

    Profiililla ilmoitetaan:

    Asiakkaan tiedot, jonka asiakirjaan tehdään välityspyyntö.

    ShortVälitettävään asiakirjaan liittyvän asiakkaan tiedot.
    InvariantsKVP-PAT-1: Syntymäaika pakollinen, kun potilaan tunnuksena tilapäinen tunnus. (Patient.identifier.where(use='temp').exists() implies Patient.birthDate.exists())
    KVP-PAT-2: 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: 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: Syntymäpäivä annettava muodossa yyyy-mm-dd (Patient.birthDate.exists() implies Patient.birthDate.toString().length()=10)
    KVP-PAT-5: 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)
    2. Patient.meta
    4. Patient.meta.profile
    Control1..1
    Fixed Value
    {
      "profile" : "https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient"
    }
    <profile value="https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient"/>
    6. Patient.implicitRules
    Control0..0
    8. Patient.language
    Control0..0
    10. Patient.text
    Control0..0
    12. Patient.identifier
    Definition

    Asiakkaan yksilöivänä tunnuksena ilmoitetaan henkilötunnus tai tilapäinen yksilöintitunnus.

    ShortAsiakkaan yksilöivä tunnus
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..?
    14. Patient.identifier:PIC
    Slice NamePIC
    Definition

    Henkilötunnus, jolla asiakas on yksilöity.

    ShortHenkilötunnus
    NoteThis is a business identifier, not a resource identifier (see discussion)
    16. Patient.identifier:PIC.id
    Control0..0
    18. Patient.identifier:PIC.type
    Control0..0
    20. Patient.identifier:PIC.system
    Definition

    Henkilötunnuksen nimiavaruutena käytetään urn:oid:1.2.246.21.

    ShortHenkilötunnuksen nimiavaruus
    22. Patient.identifier:PIC.value
    Definition

    Asiakkaan henkilötunnus ilman nimiavaruutta.

    ShortHenkilötunnus
    24. Patient.identifier:PIC.period
    Control0..0
    26. Patient.identifier:PIC.assigner
    Control0..0
    28. Patient.identifier:temp
    Slice Nametemp
    Definition

    Asiakkaan tilapäinen yksilöintitunnus

    ShortTilapäinen yksilöintitunnus
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    30. Patient.identifier:temp.id
    Control0..0
    32. Patient.identifier:temp.type
    Control0..0
    34. Patient.identifier:temp.system
    Definition

    Nimiavaruus, jota organisaatio käyttää terveydenhuollon asiakkaiden tilapäisten yksilöivien tunnusten muodostamisessa.

    OIDit terveydenhuollon yksiköiden vastuulla. Ks. tarkempi kuvaus FI Base Patient - Finnish Base Profiles v1.0.0

    ShortKäytetty nimiavaruus
    36. Patient.identifier:temp.value
    Definition

    Asiakkaan tilapäinen yksilöintitunnus ilman käytettävää nimiavaruutta.

    ShortTilapäinen yksilöintitunnus
    38. Patient.identifier:temp.period
    Control0..0
    40. Patient.identifier:temp.assigner
    Control0..0
    42. Patient.identifier:old
    Slice Nameold
    Definition

    Henkilötunnus tai tilapäinen yksilöinitunnus, jolla asiakas on yksilöity aiemmin.

    ShortAsiakkaan aiempi yksilöivä tunnus
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..0
    51. Patient.active
    Control0..0
    53. Patient.name
    Definition

    Asiakkaan virallinen nimi.

    ShortAsiakkaan nimitiedot
    Control0..1
    55. Patient.name.id
    Control0..0
    57. Patient.name.use
    Definition

    Käytetään arvoa official eli asiakkaan virallista nimeä.

    Fixed Value
    {
      "use" : "official"
    }
    <use value="official"/>
    59. Patient.name.text
    Control0..0
    61. Patient.name.family
    Definition

    Asiakkaan sukunimi

    ShortAsiakkaan sukunimi
    Control1..?
    63. Patient.name.given
    Definition

    Asiakkaan etunimet virallisessa järjestyksessä

    ShortAsiakkaan etunimet
    Control1..4
    65. Patient.name.prefix
    Control0..0
    67. Patient.name.suffix
    Control0..0
    69. Patient.name.period
    Control0..0
    71. Patient.telecom
    Control0..0
    73. Patient.gender
    Control0..0
    75. Patient.birthDate
    Definition

    Asiakkaan syntymäaika. Pakollinen, jos asiakkaan tunnisteena käytetty tilapäistä yksilöintitunnusta.

    ShortAsiakkaan syntymäaika
    LOINC Code
    77. Patient.deceased[x]
    Control0..0
    79. Patient.address
    Control0..0
    81. Patient.maritalStatus
    Control0..0
    83. Patient.multipleBirth[x]
    Control0..0
    85. Patient.photo
    Control0..0
    87. Patient.contact
    Definition

    Ajanvaraukseen liittyvän yhteyshenkilön tiedot.

    ShortYhteyshenkilön yhteystiedot
    Control0..0
    114. Patient.communication
    Definition

    Kenttään tuotetaan kielikoodiston avulla tieto asiakkaan äidinkielestä.

    Preferred arvoksi annetaan true.

    ShortAsiakkaan äidinkieli
    Control0..0
    128. Patient.generalPractitioner
    Control0..0
    130. Patient.managingOrganization
    Control0..0
    132. Patient.link
    Control0..0

    See the documentation on how to interpret the contents of this table

    0. Patient
    Definition

    Profiililla ilmoitetaan:

    Asiakkaan tiedot, jonka asiakirjaan tehdään välityspyyntö.

    ShortVälitettävään asiakirjaan liittyvän asiakkaan tiedot.
    Control0..*
    Is Modifierfalse
    Summaryfalse
    Alternate NamesSubjectOfCare Client Resident
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    KVP-PAT-1: Syntymäaika pakollinen, kun potilaan tunnuksena tilapäinen tunnus. (Patient.identifier.where(use='temp').exists() implies Patient.birthDate.exists())
    KVP-PAT-2: 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: 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: Syntymäpäivä annettava muodossa yyyy-mm-dd (Patient.birthDate.exists() implies Patient.birthDate.toString().length()=10)
    KVP-PAT-5: 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)
    2. Patient.id
    Definition

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

    ShortLogical id of this artifact
    Comments

    The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

    Control0..1
    Typeid
    Is Modifierfalse
    Summarytrue
    4. Patient.meta
    Definition

    The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

    ShortMetadata about the resource
    Control0..1
    TypeMeta
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. Patient.meta.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    8. Patient.meta.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Patient.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 10. Patient.meta.versionId
      Definition

      The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

      ShortVersion specific identifier
      Comments

      The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

      Control0..1
      Typeid
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. Patient.meta.lastUpdated
      Definition

      When the resource last changed - e.g. when the version changed.

      ShortWhen the resource version last changed
      Comments

      This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

      Control0..1
      Typeinstant
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      14. Patient.meta.source
      Definition

      A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

      ShortIdentifies where the resource comes from
      Comments

      In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

      This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

      Control0..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Patient.meta.profile
      Definition

      A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

      ShortProfiles this resource claims to conform to
      Comments

      It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

      Control1..1
      Typecanonical(StructureDefinition)
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Fixed Value
      {
        "profile" : "https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient"
      }
      <profile value="https://kvp.kanta.fi/fhir/StructureDefinition/KVPPatient"/>
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Patient.meta.security
      Definition

      Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

      ShortSecurity Labels applied to this resource
      Comments

      The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

      Control0..*
      BindingUnless not suitable, these codes SHALL be taken from All Security Labels
      (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

      Security Labels from the Healthcare Privacy and Security Classification System.

      TypeCoding
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Patient.meta.tag
      Definition

      Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

      ShortTags applied to this resource
      Comments

      The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

      Control0..*
      BindingFor example codes, see CommonTags
      (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

      Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

      TypeCoding
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Patient.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..0
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Patient.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..0
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Patient.text
      Definition

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..0
      TypeNarrative
      Is Modifierfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Patient.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      30. Patient.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      32. Patient.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Summaryfalse
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      34. Patient.identifier
      Definition

      Asiakkaan yksilöivänä tunnuksena ilmoitetaan henkilötunnus tai tilapäinen yksilöintitunnus.

      ShortAsiakkaan yksilöivä tunnus
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..*
      TypeIdentifier
      Is Modifierfalse
      Summarytrue
      Requirements

      Patients are almost always assigned specific numerical identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
      • value @ use
      • Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

        36. Patient.identifier:PIC
        Slice NamePIC
        Definition

        Henkilötunnus, jolla asiakas on yksilöity.

        ShortHenkilötunnus
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..1
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Requirements

        Patients are almost always assigned specific numerical identifiers.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Patient.identifier:PIC.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..0
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        40. Patient.identifier:PIC.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 42. Patient.identifier:PIC.use
          Definition

          The purpose of this identifier.

          Shortusual | official | temp | secondary | old (If known)
          Comments

          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

          Control1..1
          BindingThe codes SHALL be taken from IdentifierUse
          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

          Identifies the purpose for this identifier, if known .

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

          Fixed Value
          {
            "use" : "official"
          }
          <use value="official"/>
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. Patient.identifier:PIC.type
          Definition

          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

          ShortDescription of identifier
          Comments

          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

          Control0..0
          BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
          (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Requirements

          Allows users to make use of identifiers when the identifier system is not known.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. Patient.identifier:PIC.system
          Definition

          Henkilötunnuksen nimiavaruutena käytetään urn:oid:1.2.246.21.

          ShortHenkilötunnuksen nimiavaruus
          Comments

          Identifier.system is always case sensitive.

          Control1..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

          Fixed Value
          {
            "system" : "urn:oid:1.2.246.21"
          }
          <system value="urn:oid:1.2.246.21"/>
          ExampleGeneral: http://www.acme.com/identifiers/patient
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. Patient.identifier:PIC.value
          Definition

          Asiakkaan henkilötunnus ilman nimiavaruutta.

          ShortHenkilötunnus
          Comments

          If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

          Control1..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          ExampleGeneral: 123456
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. Patient.identifier:PIC.period
          Definition

          Time period during which identifier is/was valid for use.

          ShortTime period when id is/was valid for use
          Control0..0
          TypePeriod
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. Patient.identifier:PIC.assigner
          Definition

          Organization that issued/manages the identifier.

          ShortOrganization that issued id (may be just text)
          Comments

          The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

          Control0..0
          TypeReference(Organization)
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          54. Patient.identifier:temp
          Slice Nametemp
          Definition

          Asiakkaan tilapäinen yksilöintitunnus

          ShortTilapäinen yksilöintitunnus
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1
          TypeIdentifier
          Is Modifierfalse
          Summarytrue
          Requirements

          Patients are almost always assigned specific numerical identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          56. Patient.identifier:temp.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..0
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          58. Patient.identifier:temp.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 60. Patient.identifier:temp.use
            Definition

            The purpose of this identifier.

            Shortusual | official | temp | secondary | old (If known)
            Comments

            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

            Control1..1
            BindingThe codes SHALL be taken from IdentifierUse
            (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

            Identifies the purpose for this identifier, if known .

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

            Fixed Value
            {
              "use" : "temp"
            }
            <use value="temp"/>
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. Patient.identifier:temp.type
            Definition

            A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

            ShortDescription of identifier
            Comments

            This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

            Control0..0
            BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
            (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

            A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows users to make use of identifiers when the identifier system is not known.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            64. Patient.identifier:temp.system
            Definition

            Nimiavaruus, jota organisaatio käyttää terveydenhuollon asiakkaiden tilapäisten yksilöivien tunnusten muodostamisessa.

            OIDit terveydenhuollon yksiköiden vastuulla. Ks. tarkempi kuvaus FI Base Patient - Finnish Base Profiles v1.0.0

            ShortKäytetty nimiavaruus
            Comments

            Identifier.system is always case sensitive.

            Control1..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

            ExampleGeneral: http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            66. Patient.identifier:temp.value
            Definition

            Asiakkaan tilapäinen yksilöintitunnus ilman käytettävää nimiavaruutta.

            ShortTilapäinen yksilöintitunnus
            Comments

            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

            Control1..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            ExampleGeneral: 123456
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            68. Patient.identifier:temp.period
            Definition

            Time period during which identifier is/was valid for use.

            ShortTime period when id is/was valid for use
            Control0..0
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            70. Patient.identifier:temp.assigner
            Definition

            Organization that issued/manages the identifier.

            ShortOrganization that issued id (may be just text)
            Comments

            The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

            Control0..0
            TypeReference(Organization)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            72. Patient.identifier:old
            Slice Nameold
            Definition

            Henkilötunnus tai tilapäinen yksilöinitunnus, jolla asiakas on yksilöity aiemmin.

            ShortAsiakkaan aiempi yksilöivä tunnus
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..0
            TypeIdentifier
            Is Modifierfalse
            Summarytrue
            Requirements

            Patients are almost always assigned specific numerical identifiers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            82. Patient.active
            Definition

            Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

            It is often used to filter patient lists to exclude inactive patients

            Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

            ShortWhether this patient's record is in active use
            Comments

            If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

            Control0..0
            Typeboolean
            Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to be able to mark a patient record as not to be used because it was created in error.

            Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. Patient.name
            Definition

            Asiakkaan virallinen nimi.

            ShortAsiakkaan nimitiedot
            Comments

            A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

            Control0..1
            TypeHumanName
            Is Modifierfalse
            Summarytrue
            Requirements

            Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. Patient.name.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..0
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            88. Patient.name.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 90. Patient.name.use
              Definition

              Käytetään arvoa official eli asiakkaan virallista nimeä.

              Shortusual | official | temp | nickname | anonymous | old | maiden
              Comments

              Applications can assume that a name is current unless it explicitly says that it is temporary or old.

              Control0..1
              BindingThe codes SHALL be taken from NameUse
              (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

              The use of a human name.

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows the appropriate name for a particular context of use to be selected from among a set of names.

              Fixed Value
              {
                "use" : "official"
              }
              <use value="official"/>
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              92. Patient.name.text
              Definition

              Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

              ShortText representation of the full name
              Comments

              Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              A renderable, unencoded form.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              94. Patient.name.family
              Definition

              Asiakkaan sukunimi

              ShortAsiakkaan sukunimi
              Comments

              Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate Namessurname
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              96. Patient.name.given
              Definition

              Asiakkaan etunimet virallisessa järjestyksessä

              ShortAsiakkaan etunimet
              Comments

              If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

              Control1..4
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate Namesfirst name, middle name
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              98. Patient.name.prefix
              Definition

              Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

              ShortParts that come before the name
              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              100. Patient.name.suffix
              Definition

              Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

              ShortParts that come after the name
              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              102. Patient.name.period
              Definition

              Indicates the period of time when this name was valid for the named person.

              ShortTime period when name was/is in use
              Control0..0
              TypePeriod
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows names to be placed in historical context.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              104. Patient.telecom
              Definition

              A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

              ShortA contact detail for the individual
              Comments

              A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

              Control0..0
              TypeContactPoint
              Is Modifierfalse
              Summarytrue
              Requirements

              People have (primary) ways to contact them in some way such as phone, email.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              106. Patient.gender
              Definition

              Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

              Shortmale | female | other | unknown
              Comments

              The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

              Control0..0
              BindingThe codes SHALL be taken from AdministrativeGender
              (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

              The gender of a person used for administrative purposes.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Needed for identification of the individual, in combination with (at least) name and birth date.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              108. Patient.birthDate
              Definition

              Asiakkaan syntymäaika. Pakollinen, jos asiakkaan tunnisteena käytetty tilapäistä yksilöintitunnusta.

              ShortAsiakkaan syntymäaika
              Comments

              At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

              Control0..1
              Typedate
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Age of the individual drives many clinical processes.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              LOINC Code21112-8
              110. Patient.deceased[x]
              Definition

              Indicates if the individual is deceased or not.

              ShortIndicates if the individual is deceased or not
              Comments

              If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

              Control0..0
              TypeChoice of: boolean, dateTime
              Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              112. Patient.address
              Definition

              An address for the individual.

              ShortAn address for the individual
              Comments

              Patient may have multiple addresses with different uses or applicable periods.

              Control0..0
              TypeAddress
              Is Modifierfalse
              Summarytrue
              Requirements

              May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              114. Patient.maritalStatus
              Definition

              This field contains a patient's most recent marital (civil) status.

              ShortMarital (civil) status of a patient
              Control0..0
              BindingUnless not suitable, these codes SHALL be taken from Marital Status Codes
              (extensible to http://hl7.org/fhir/ValueSet/marital-status|4.0.1)

              The domestic partnership status of a person.

              TypeCodeableConcept
              Is Modifierfalse
              Summaryfalse
              Requirements

              Most, if not all systems capture it.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              116. Patient.multipleBirth[x]
              Definition

              Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

              ShortWhether patient is part of a multiple birth
              Comments

              Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

              Control0..0
              TypeChoice of: boolean, integer
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Requirements

              For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              118. Patient.photo
              Definition

              Image of the patient.

              ShortImage of the patient
              Comments

              Guidelines:

              • Use id photos, not clinical photos.
              • Limit dimensions to thumbnail.
              • Keep byte count low to ease resource updates.
              Control0..0
              TypeAttachment
              Is Modifierfalse
              Summaryfalse
              Requirements

              Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              120. Patient.contact
              Definition

              Ajanvaraukseen liittyvän yhteyshenkilön tiedot.

              ShortYhteyshenkilön yhteystiedot
              Comments

              Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

              Control0..0
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Requirements

              Need to track people you can contact about the patient.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              pat-1: 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())
              152. Patient.communication
              Definition

              Kenttään tuotetaan kielikoodiston avulla tieto asiakkaan äidinkielestä.

              Preferred arvoksi annetaan true.

              ShortAsiakkaan äidinkieli
              Comments

              If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

              Control0..0
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Requirements

              If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              170. Patient.generalPractitioner
              Definition

              Patient's nominated care provider.

              ShortPatient's nominated primary care provider
              Comments

              This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

              Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

              Control0..0
              TypeReference(Organization, Practitioner, PractitionerRole)
              Is Modifierfalse
              Summaryfalse
              Alternate NamescareProvider
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              172. Patient.managingOrganization
              Definition

              Organization that is the custodian of the patient record.

              ShortOrganization that is the custodian of the patient record
              Comments

              There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

              Control0..0
              TypeReference(Organization)
              Is Modifierfalse
              Summarytrue
              Requirements

              Need to know who recognizes this patient record, manages and updates it.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              174. Patient.link
              Definition

              Link to another patient resource that concerns the same actual patient.

              ShortLink to another patient resource that concerns the same actual person
              Comments

              There is no assumption that linked patient records have mutual links.

              Control0..0
              TypeBackboneElement
              Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
              Summarytrue
              Requirements

              There are multiple use cases:

              • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
              • Distribution of patient information across multiple servers.
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))