Person
General information
See HL7 Person for general information regarding the Person resource.
Scope and Usage
This profile contains demographic information about an individual, comparable to data in the population registry (folkbokföring). This profile has been designed to cover data about individuals specifically in a Swedish and European context. This has been done by using the same profiling as the Swedish base profile for Patient for valid types of identification in Sweden and for marking the personal data as protected demographic information (using meta.security).
Extensions for being able to express address lines as well as country in a structured way have been provided in the Address profile, as profiled by the European base profiles.
This guide defines a profile for HumanName that includes the nameQualifier extension on the name.given element. It can be used to mark the supplied given name(s) as what the patient is called by, as well as a middleName extension.
Boundaries and Relationships
The resource can be used together with other role based resources (Patient, Practitioner and/or RelatedPerson) or other Person instances, to show that they pertain to the same individual. Linking a Person instance with another resource instance is done using the link element or by using the same business identifiers, for example using the Swedish personal identity nummer.
Background and Context
The Person resource is not commonly used in FHIR, as most use cases require knowing what role an individual has in that context. While it is not predicted to be used in EHDS, there are systems where the Person resource is used as master data from which role based resource instances can get populated. Hence it is profiled in this guide as reference material for those use cases.
Profile
| NPPRPerson (Person) | C | Person | |
| id | Σ | 0..1 | id |
| meta | S Σ | 0..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | Σ | 0..* | canonical(StructureDefinition) |
| security | S Σ C | 0..* | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 0..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ C | 0..1 | code |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| tag | Σ C | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | C | 0..1 | Narrative |
| contained | C | 0..* | Resource |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| identifier | S Σ C | 1..1 | Identifier |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| coordinationNumber | S Σ C | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uriPattern |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| personalIdentityNumber | S Σ C | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uriPattern |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| active | Σ ?! | 0..1 | boolean |
| name | S Σ | 1..1 | NPPRHumanName |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| middleName | S C | 0..1 | Extension(string) |
| use | Σ ?! | 0..1 | codeBinding |
| text | S Σ | 0..1 | string |
| family | S Σ | 1..1 | string |
| given | S Σ | 1..* | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| nameQualifier | S C | 0..1 | Extension(code) |
| value | 0..1 | System.String | |
| prefix | Σ | 0..* | string |
| suffix | Σ | 0..* | string |
| period | Σ C | 0..1 | Period |
| telecom | S Σ C | 0..* | NPPRContactPoint |
| gender | S Σ | 1..1 | codeBinding |
| birthDate | S Σ | 1..1 | date |
| deceased[x] | Σ | 0..1 | |
| deceasedBoolean | boolean | ||
| deceasedDateTime | dateTime | ||
| address | S Σ | 0..* | NPPRAddress |
| id | 0..1 | string | |
| extension | C | 1..* | Extension |
| officialAddressType | S C | 1..1 | Extension(CodeableConcept) |
| use | S Σ ?! | 0..1 | codeBinding |
| type | S Σ | 0..1 | codeBinding |
| text | Σ | 0..1 | string |
| line | S Σ | 0..* | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| streetName | S C | 0..1 | Extension(string) |
| houseNumber | S C | 0..1 | Extension(string) |
| postBox | S C | 0..1 | Extension(string) |
| value | S | 0..1 | System.String |
| city | S Σ | 0..1 | string |
| district | Σ | 0..1 | string |
| state | Σ | 0..1 | string |
| postalCode | S Σ | 0..1 | string |
| country | S Σ | 0..1 | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| countryCode | S C | 0..1 | Extension(Coding) |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | C | 1..1 | Binding |
| valueCoding | Coding | ||
| value | 0..1 | System.String | |
| period | S Σ C | 1..1 | Period |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| start | S Σ C | 1..1 | dateTime |
| end | S Σ C | 0..1 | dateTime |
| maritalStatus | S | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ C | 1..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| photo | C | 0..* | Attachment |
| communication | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| language | 1..1 | CodeableConceptBinding | |
| preferred | 0..1 | boolean | |
| managingOrganization | Σ C | 0..1 | Reference(Organization) |
| link | S | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| target | S C | 1..1 | Reference(NPPRPatient | NPPRPractitioner | NPPRRelatedPerson) |
| assurance | 0..1 | codeBinding |
| Person | |
| Short | A generic person record |
| Definition | Demographics and administrative information about a person independent of a specific health-related context. |
| Cardinality | 0..* |
| Comments | The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare). |
| Constraints |
|
| Mappings |
|
| Person.id | |
| Short | Logical id of this artifact |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Cardinality | 0..1 |
| Type | id |
| Summary | True |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Constraints |
|
| Mappings |
|
| Person.meta | |
| Short | Metadata about the resource |
| 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. |
| Cardinality | 0..1 |
| Type | Meta |
| Must Support | True |
| Summary | True |
| Constraints |
|
| Mappings |
|
| Person.meta.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.meta.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.meta.versionId | |
| Short | Version specific identifier |
| 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. |
| Cardinality | 0..1 |
| Type | id |
| Summary | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.meta.lastUpdated | |
| Short | When the resource version last changed |
| Definition | When the resource last changed - e.g. when the version changed. |
| Cardinality | 0..1 |
| Type | instant |
| Summary | True |
| Comments | This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. 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. |
| Constraints |
|
| Mappings |
|
| Person.meta.source | |
| Short | Identifies where the resource comes from |
| 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. |
| Cardinality | 0..1 |
| Type | uri |
| Summary | True |
| Comments | The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. 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. |
| Constraints |
|
| Mappings |
|
| Person.meta.profile | |
| Short | Profiles this resource claims to conform to |
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
| Cardinality | 0..* |
| Type | canonical(StructureDefinition) |
| Summary | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.meta.security | |
| Short | Security Labels applied to this resource |
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
| Cardinality | 0..* |
| Type | Coding |
| Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
| Must Support | True |
| Summary | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.meta.security.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.meta.security.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.meta.security.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 0..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| Person.meta.security.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| Person.meta.security.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 0..1 |
| Type | code |
| Must Support | True |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Person.meta.security.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Person.meta.security.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..1 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| Person.meta.tag | |
| Short | Tags applied to this resource |
| 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. |
| Cardinality | 0..* |
| Type | Coding |
| Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| Summary | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.implicitRules | |
| Short | A set of rules under which this content was created |
| 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. |
| Cardinality | 0..1 |
| Type | uri |
| Modifier | True |
| Summary | True |
| 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 its narrative along with other profiles, value sets, etc. |
| Constraints |
|
| Mappings |
|
| Person.language | |
| Short | Language of the resource content |
| Definition | The base language in which the resource is written. |
| Cardinality | 0..1 |
| Type | code |
| Binding | IETF language tag for a human language |
| 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). |
| Constraints |
|
| Mappings |
|
| Person.text | |
| Short | Text summary of the resource, for human interpretation |
| 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. |
| Cardinality | 0..1 |
| Type | Narrative |
| Alias | narrative, html, xhtml, display |
| Comments | Contained resources do not have a 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-6 |
| Constraints |
|
| Mappings |
|
| Person.contained | |
| Short | Contained, inline Resources |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Cardinality | 0..* |
| Type | Resource |
| Alias | inline resources, anonymous resources, contained 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| Mappings |
|
| Person.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.modifierExtension | |
| Short | Extensions that cannot be ignored |
| 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 managable, 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). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content |
| 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. |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.identifier | |
| Short | A human identifier for this person |
| Definition | Identifier for a person within a particular scope. |
| Cardinality | 1..1 |
| Type | Identifier |
| Must Support | True |
| Summary | True |
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier. |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Slicing | Unordered, Open, by system(Value) Slice on Identifier based on the system value |
| Constraints |
|
| Mappings |
|
| Person.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.identifier.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Person.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| 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. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Person.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Person.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Person.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.identifier:coordinationNumber | |
| Short | A human identifier for this person |
| Definition | Identifier for a person within a particular scope. |
| Cardinality | 0..1 |
| Type | Identifier |
| Must Support | True |
| Summary | True |
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier. |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Constraints |
|
| Mappings |
|
| Person.identifier:coordinationNumber.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.identifier:coordinationNumber.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.identifier:coordinationNumber.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Person.identifier:coordinationNumber.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.identifier:coordinationNumber.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| 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. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Pattern | http://electronichealth.se/identifier/samordningsnummer |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Person.identifier:coordinationNumber.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Person.identifier:coordinationNumber.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Person.identifier:coordinationNumber.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.identifier:personalIdentityNumber | |
| Short | A human identifier for this person |
| Definition | Identifier for a person within a particular scope. |
| Cardinality | 0..1 |
| Type | Identifier |
| Must Support | True |
| Summary | True |
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier. |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Constraints |
|
| Mappings |
|
| Person.identifier:personalIdentityNumber.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.identifier:personalIdentityNumber.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.identifier:personalIdentityNumber.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Person.identifier:personalIdentityNumber.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.identifier:personalIdentityNumber.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| 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. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Pattern | http://electronichealth.se/identifier/personnummer |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Person.identifier:personalIdentityNumber.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Person.identifier:personalIdentityNumber.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Person.identifier:personalIdentityNumber.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.active | |
| Short | This person's record is in active use |
| Definition | Whether this person's record is in active use. |
| Cardinality | 0..1 |
| Type | boolean |
| Modifier | True |
| Summary | True |
| Requirements | Need to be able to mark a person record as not to be used because it was created in error. |
| Constraints |
|
| Mappings |
|
| Person.name | |
| Short | Name of a human or other living entity - parts and usage |
| Definition | A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information. |
| Cardinality | 1..1 |
| Type | NPPRHumanName |
| Must Support | True |
| Summary | True |
| Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. |
| Constraints |
|
| Mappings |
|
| Person.name.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.name.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.name.extension:middleName | |
| Short | Optional Extensions Element |
| Definition | Extension for HumanName to express middle names. |
| Cardinality | 0..1 |
| Type | Extension(string) |
| Must Support | True |
| Alias | extensions, user content |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.name.use | |
| Short | usual | official | temp | nickname | anonymous | old | maiden |
| Definition | Identifies the purpose for this name. |
| Cardinality | 0..1 |
| Type | code |
| Binding | The use of a human name. |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
| Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| Constraints |
|
| Mappings |
|
| Person.name.text | |
| Short | Text representation of the full name |
| 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. |
| Cardinality | 0..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Requirements | A renderable, unencoded form. |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.name.family | |
| Short | Family name (often called 'Surname') |
| Definition | 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. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Alias | surname |
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
| Constraints |
|
| Mappings |
|
| Person.name.given | |
| Short | Given names (not always 'first'). Includes middle names |
| Definition | Given name. |
| Cardinality | 1..* |
| Type | string |
| Must Support | True |
| Summary | True |
| Alias | first name, middle name |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.name.given.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.name.given.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.name.given.extension:nameQualifier | |
| Short | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV |
| Definition | A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. |
| Cardinality | 0..1 |
| Type | Extension(code) |
| Must Support | True |
| Alias | extensions, user content |
| Comments | Used to indicate additional information about the name part and how it should be used. |
| Constraints |
|
| Mappings |
|
| Person.name.given.value | |
| Short | Primitive value for string |
| Definition | Primitive value for string |
| Cardinality | 0..1 |
| Type | System.String |
| Maximum string length | 1048576 |
| Person.name.prefix | |
| Short | Parts that come before the name |
| 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. |
| Cardinality | 0..* |
| Type | string |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Person.name.suffix | |
| Short | Parts that come after the name |
| 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. |
| Cardinality | 0..* |
| Type | string |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Person.name.period | |
| Short | Time period when name was/is in use |
| Definition | Indicates the period of time when this name was valid for the named person. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Requirements | Allows names to be placed in historical context. |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Person.telecom | |
| Short | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. |
| Cardinality | 0..* |
| Type | NPPRContactPoint |
| Must Support | True |
| Summary | True |
| Requirements | People have (primary) ways to contact them in some way such as phone, email. |
| Comments | Person 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. |
| Constraints |
|
| Mappings |
|
| Person.gender | |
| Short | male | female | other | unknown |
| Definition | Administrative Gender. |
| Cardinality | 1..1 |
| Type | code |
| Binding | The gender of a person used for administrative purposes. |
| Must Support | True |
| Summary | True |
| Requirements | Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes. |
| 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 M and F, though a clear majority of systems and contexts only support M and F. |
| Constraints |
|
| Mappings |
|
| Person.birthDate | |
| Short | The date on which the person was born |
| Definition | The birth date for the person. |
| Cardinality | 1..1 |
| Type | date |
| Must Support | True |
| Summary | True |
| Requirements | Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues. |
| Comments | At least an estimated year should be provided as a guess if the real DOB is unknown. |
| Constraints |
|
| Mappings |
|
| Person.deceased[x] | |
| Short | Indicates if the individual is deceased or not |
| Definition | Indicates if the individual is deceased or not. |
| Cardinality | 0..1 |
| Type | boolean | dateTime |
| Summary | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.address | |
| Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address. |
| Cardinality | 0..* |
| Type | NPPRAddress |
| Must Support | True |
| Summary | True |
| Requirements | May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification. |
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Constraints |
|
| Mappings |
|
| Person.address.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.address.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 1..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.address.extension:officialAddressType | |
| Short | Optional Extensions Element |
| Definition | Extension for Address to express official address type. |
| Cardinality | 1..1 |
| Type | Extension(CodeableConcept) |
| Must Support | True |
| Alias | extensions, user content |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.address.use | |
| Short | home | work | temp | old | billing - purpose of this address |
| Definition | The purpose of this address. |
| Cardinality | 0..1 |
| Type | code |
| Binding | The use of an address (home / work / etc.). |
| Must Support | True |
| Modifier | True |
| Summary | True |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Constraints |
|
| Examples | Generalhome |
| Mappings |
|
| Person.address.type | |
| Short | postal | physical | both |
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
| Cardinality | 0..1 |
| Type | code |
| Binding | The type of an address (physical / postal). |
| Must Support | True |
| Summary | True |
| Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Constraints |
|
| Examples | Generalboth |
| Mappings |
|
| Person.address.text | |
| Short | Text representation of the address |
| Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Requirements | A renderable, unencoded form. |
| Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Constraints |
|
| Examples | General137 Nowhere Street, Erewhon 9132 |
| Mappings |
|
| Person.address.line | |
| Short | Street name, number, direction & P.O. Box etc. |
| Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
| Cardinality | 0..* |
| Type | string |
| Must Support | True |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Examples | General137 Nowhere Street |
| Mappings |
|
| Person.address.line.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.address.line.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.address.line.extension:streetName | |
| Short | streetName |
| Definition | streetName. |
| Cardinality | 0..1 |
| Type | Extension(string) |
| Must Support | True |
| Alias | extensions, user content |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.address.line.extension:houseNumber | |
| Short | houseNumber |
| Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. |
| Cardinality | 0..1 |
| Type | Extension(string) |
| Must Support | True |
| Alias | extensions, user content |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.address.line.extension:postBox | |
| Short | postBox |
| Definition | A numbered box located in a post station. |
| Cardinality | 0..1 |
| Type | Extension(string) |
| Must Support | True |
| Alias | extensions, user content |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.address.line.value | |
| Short | Primitive value for string |
| Definition | Primitive value for string |
| Cardinality | 0..1 |
| Type | System.String |
| Must Support | True |
| Maximum string length | 1048576 |
| Person.address.city | |
| Short | Name of city, town etc. |
| Definition | The name of the city, town, suburb, village or other community or delivery center. |
| Cardinality | 0..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Alias | Municpality |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Examples | GeneralErewhon |
| Mappings |
|
| Person.address.district | |
| Short | District name (aka county) |
| Definition | The name of the administrative area (county). |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Alias | County |
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
| Constraints |
|
| Examples | GeneralMadison |
| Mappings |
|
| Person.address.state | |
| Short | Sub-unit of country (abbreviations ok) |
| Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Alias | Province, Territory |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Person.address.postalCode | |
| Short | Postal code for area |
| Definition | A postal code designating a region defined by the postal service. |
| Cardinality | 0..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Alias | Zip |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Examples | General9132 |
| Mappings |
|
| Person.address.country | |
| Short | Country (e.g. may be ISO 3166 2 or 3 letter code) |
| Definition | Country - a nation as commonly understood or generally accepted. |
| Cardinality | 0..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Comments | ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name. |
| Constraints |
|
| Mappings |
|
| Person.address.country.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.address.country.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.address.country.extension:countryCode | |
| Short | code for string |
| Definition | Provides a coded expression for the content represented in a string. |
| Cardinality | 0..1 |
| Type | Extension(Coding) |
| Must Support | True |
| Alias | extensions, user content |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.address.country.extension:countryCode.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.address.country.extension:countryCode.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.address.country.extension:countryCode.url | |
| Short | identifies the meaning of the extension |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Cardinality | 1..1 |
| Type | uri |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-codedString |
| Mappings |
|
| Person.address.country.extension:countryCode.value[x] | |
| Short | Value of extension |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | Coding |
| Binding | A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ext-1 |
| Constraints |
|
| Mappings |
|
| Person.address.country.value | |
| Short | Primitive value for string |
| Definition | Primitive value for string |
| Cardinality | 0..1 |
| Type | System.String |
| Maximum string length | 1048576 |
| Person.address.period | |
| Short | Time period when address was/is in use |
| Definition | Time period when address was/is in use. |
| Cardinality | 1..1 |
| Type | Period |
| Must Support | True |
| Summary | True |
| Requirements | Allows addresses to be placed in historical context. |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Examples | General{
"start": "2010-03-23",
"end": "2010-07-01"
} |
| Mappings |
|
| Person.address.period.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.address.period.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.address.period.start | |
| Short | Starting time with inclusive boundary |
| Definition | The start of the period. The boundary is inclusive. |
| Cardinality | 1..1 |
| Type | dateTime |
| Must Support | True |
| Summary | True |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| Person.address.period.end | |
| Short | End time with inclusive boundary, if not ongoing |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Cardinality | 0..1 |
| Type | dateTime |
| Must Support | True |
| Summary | True |
| Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus | |
| Short | Marital (civil) status of a person |
| Definition | This field contains a person's most recent marital (civil) status. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | The domestic partnership status of a person. |
| Must Support | True |
| Comments | Many countries maintain a register of births, deaths and marriages, and this would simplify that interaction |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.maritalStatus.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..1 |
| Type | Coding |
| Must Support | True |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.maritalStatus.coding.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Must Support | True |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..1 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| Person.maritalStatus.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| Person.photo | |
| Short | Image of the person |
| Definition | An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. |
| Cardinality | 0..* |
| Type | Attachment |
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". |
| Constraints |
|
| Mappings |
|
| Person.communication | |
| Short | A language which may be used to communicate with the person about his or her health |
| Definition | A language which may be used to communicate with the person about his or her health. |
| Cardinality | 0..* |
| Type | BackboneElement |
| Requirements | If a person does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for person and other persons of interest. |
| 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 Person.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. Note that this property should not be used to update any linked/logically linked practitioner resources as it serves as a language that can be used to communicate with patients - however it may be used to inform the value on practitioner, along with their role at the organization (with the practitioner's permission) |
| Constraints |
|
| Mappings |
|
| Person.communication.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.communication.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.communication.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 managable, 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. 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). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| 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. |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.communication.language | |
| Short | The language which can be used to communicate with the person about his or her health |
| Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | IETF language tag for a human language |
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. |
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |
| Constraints |
|
| Mappings |
|
| Person.communication.preferred | |
| Short | Language preference indicator |
| Definition | Indicates whether or not the person prefers this language (over other languages he masters up a certain level). |
| Cardinality | 0..1 |
| Type | boolean |
| Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. |
| Comments | This language is specifically identified for communicating healthcare information. |
| Constraints |
|
| Mappings |
|
| Person.managingOrganization | |
| Short | The organization that is the custodian of the person record |
| Definition | The organization that is the custodian of the person record. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Requirements | Need to know who recognizes this person record, manages and updates it. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| Person.link | |
| Short | Link to a resource that concerns the same actual person |
| Definition | Link to a resource that concerns the same actual person. |
| Cardinality | 0..* |
| Type | BackboneElement |
| Must Support | True |
| Constraints |
|
| Mappings |
|
| Person.link.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Person.link.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Person.link.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 managable, 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. 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). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| 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. |
| 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. |
| Constraints |
|
| Mappings |
|
| Person.link.target | |
| Short | The resource to which this actual person is associated |
| Definition | The resource to which this actual person is associated. |
| Cardinality | 1..1 |
| Type | Reference(NPPRPatient | NPPRPractitioner | NPPRRelatedPerson) |
| Must Support | True |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| Person.link.assurance | |
| Short | level1 | level2 | level3 | level4 |
| Definition | Level of assurance that this link is associated with the target resource. |
| Cardinality | 0..1 |
| Type | code |
| Binding | The level of confidence that this link represents the same actual person, based on NIST Authentication Levels. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
Constraints
| Path | Id | Grade | Details | Expression |
|---|---|---|---|---|
| Person.telecom | nppr-telecom-phone-1 | warning | If telecom.system = #phone, value should follow format +46123456789 | value.matches('^\\+[1-9][0-9]+$') or system != 'phone' |
| Person.telecom | nppr-telecom-url-1 | warning | If telecom.system = #url, value should follow valid format. Example: https://example.com | value.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url' |
| Person.telecom | nppr-telecom-email-1 | warning | If telecom.system = #email, value should follow valid format Example: test@test.com | value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email' |
Terminology Bindings
| Path | Strength | ValueSet |
|---|---|---|
| Person.gender | required | http://electronichealth.se/fhir/NPPR/ValueSet/nppr-administrative-gender |
| Person.maritalStatus | extensible | http://electronichealth.se/fhir/NPPR/ValueSet/nppr-marital-status |
Mapping
A mapping between this profile and the information model is shown below.
| NPPRPersonLogical | Base | ||
| person-id | C | 1..1 | Identifier |
| fornamn | 0..* | string | |
| efternamn | 1..1 | string | |
| mellannamn | 0..1 | string | |
| tilltalsnamnsmarkering | 1..1 | integer | |
| kon | C | 1..1 | Coding |
| fodelsedatum | 1..1 | dateTime | |
| sekretessmarkering | 1..1 | boolean | |
| skyddadFolkbokforing | 1..1 | boolean | |
| civilstand | C | 1..1 | Coding |
| forsakringsmedlemsstat | C | 0..1 | Coding |
| harAdressIFormAv | C | 0..* | Reference(NPPRKontaktuppgiftLogical) |
Examples
Person with middle name
Person with middle name extension.
| Person |
| id : e3c13bb1-236e-424c-a28e-e266be42b073 |
| meta |
| profile : http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson |
| text |
| status : additional |
| identifier |
| system : http://electronichealth.se/identifier/samordningsnummer |
| value : 191605862398 |
| name |
| extension |
| url : http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRMiddleNameExtension |
| value : Stefan |
| family : Johansson |
| given : Jimmy |
| gender : male |
| birthDate : 1916-05-26 |
| maritalStatus |
| coding |
| system : http://terminology.hl7.org/CodeSystem/v3-MaritalStatus |
| code : M |
Person with link reference
Person with link reference to Patient instance, to explain that the Person and the Patient instances regard the same person.
| Person |
| id : b70186fb-432d-4077-a085-73d09107055b |
| meta |
| profile : http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson |
| security |
| system : http://hl7.se/fhir/ig/base/CodeSystem/SecurityLabel |
| code : sekretessmarkering |
| display : Sekretessmarkering |
| text |
| status : additional |
| identifier |
| system : http://electronichealth.se/identifier/samordningsnummer |
| value : 191605862398 |
| period |
| start : 2015-02-07T13:28:17.239+02:00 |
| end : 2015-02-07T13:28:17.239+02:00 |
| name |
| family : Svensson |
| given : Anna |
| given : Maria |
| telecom |
| system : phone |
| value : +46701234567 |
| use : mobile |
| rank : 1 |
| period |
| start : 2015-02-07T13:28:17.239+02:00 |
| end : 2025-02-07T13:28:17.239+02:00 |
| telecom |
| system : email |
| value : anna.svensson@example.org |
| period |
| start : 2015-02-07T13:28:17.239+02:00 |
| gender : female |
| birthDate : 1916-05-26 |
| address |
| extension |
| url : http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPROfficialAddressTypeExtension |
| value |
| coding |
| system : http://snomed.info/sct |
| code : 63381000052101 |
| line : Storgatan 12 |
| city : Stockholm |
| postalCode : 11456 |
| country : SE |
| period |
| start : 2015-02-07T13:28:17.239+02:00 |
| maritalStatus |
| coding |
| system : http://terminology.hl7.org/CodeSystem/v3-MaritalStatus |
| code : M |
| display : Married |
| link |
| target |
| reference : Patient/6d493572-0375-40a7-97eb-6a91ee7f72a0 |