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

idΣ0..1id
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeS Σ C0..1code
displayΣ C0..1string
userSelectedΣ0..1boolean
tagΣ C0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
containedC0..*Resource
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ C1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriPattern
valueS Σ C1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriPattern
valueS Σ C1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
activeΣ ?!0..1boolean
id0..1string
middleNameS C0..1Extension(string)
useΣ ?!0..1codeBinding
textS Σ0..1string
familyS Σ1..1string
id0..1string
nameQualifierS C0..1Extension(code)
value0..1System.String
prefixΣ0..*string
suffixΣ0..*string
periodΣ C0..1Period
telecomS Σ C0..*NPPRContactPoint
genderS Σ1..1codeBinding
birthDateS Σ1..1date
deceasedBooleanboolean
deceasedDateTimedateTime
id0..1string
officialAddressTypeS C1..1Extension(CodeableConcept)
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textΣ0..1string
id0..1string
streetNameS C0..1Extension(string)
houseNumberS C0..1Extension(string)
postBoxS C0..1Extension(string)
valueS0..1System.String
cityS Σ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeS Σ0..1string
id0..1string
id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valueCodingCoding
value0..1System.String
id0..1string
extensionC0..*Extension
startS Σ C1..1dateTime
endS Σ C0..1dateTime
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ C1..1code
displayΣ C0..1string
userSelectedΣ0..1boolean
textΣ0..1string
photoC0..*Attachment
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
language1..1CodeableConceptBinding
preferred0..1boolean
managingOrganizationΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
targetS C1..1Reference(NPPRPatient | NPPRPractitioner | NPPRRelatedPerson)
assurance0..1codeBinding
Person
ShortA generic person record
Definition

Demographics and administrative information about a person independent of a specific health-related context.

Cardinality0..*
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
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • rim: Entity, Role, or Act
  • w5: administrative.entity
  • rim: Person(classCode="PSN" and determinerCode="INST" and quantity="1")
Person.id
ShortLogical 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.

Cardinality0..1
Typeid
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Person.meta
ShortMetadata 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.

Cardinality0..1
TypeMeta
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Person.meta.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.meta.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.meta.versionId
ShortVersion 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.

Cardinality0..1
Typeid
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Person.meta.lastUpdated
ShortWhen the resource version last changed
Definition

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

Cardinality0..1
Typeinstant
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Person.meta.source
ShortIdentifies 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.

Cardinality0..1
Typeuri
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Person.meta.profile
ShortProfiles 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.

Cardinality0..*
Typecanonical(StructureDefinition)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Person.meta.security
ShortSecurity Labels applied to this resource
Definition

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

Cardinality0..*
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

AllSecurityLabels (extensible)

Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
    code.exists().not() implies display.exists().not()
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • NPPRPersonToNPPRPersonLogical: sekretessmarkering
  • NPPRPersonToNPPRPersonLogical: skyddadFolkbokforing
Person.meta.security.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.meta.security.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.meta.security.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality0..1
Typeuri
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Person.meta.security.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Person.meta.security.code
ShortSymbol 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).

Cardinality0..1
Typecode
Must SupportTrue
SummaryTrue
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

ConditionsThe cardinality or value of this element may be affected by these constraints: cod-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Person.meta.security.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
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

ConditionsThe cardinality or value of this element may be affected by these constraints: cod-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Person.meta.security.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Person.meta.tag
ShortTags 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.

Cardinality0..*
TypeCoding
Binding

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

CommonTags (example)

SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
    code.exists().not() implies display.exists().not()
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
Person.implicitRules
ShortA 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.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Person.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)

Additional bindings
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Person.text
ShortText 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.

Cardinality0..1
TypeNarrative
Aliasnarrative, 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.

ConditionsThe cardinality or value of this element may be affected by these constraints: dom-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Person.contained
ShortContained, 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.

Cardinality0..*
TypeResource
Aliasinline 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.

ConditionsThe cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • rim: N/A
Person.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.modifierExtension
ShortExtensions 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.identifier
ShortA human identifier for this person
Definition

Identifier for a person within a particular scope.

Cardinality1..1
TypeIdentifier
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: .plays:Role(classCode='IDENT').id
  • NPPRPersonToNPPRPersonLogical: person-id
Person.identifier.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.identifier.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.identifier.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Person.identifier.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

IdentifierTypeCodes (extensible)

SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
Person.identifier.system
ShortThe 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.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

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

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Person.identifier.value
ShortThe 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ident-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Person.identifier.period
ShortTime period when id is/was valid for use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Person.identifier.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Person.identifier:coordinationNumber
ShortA human identifier for this person
Definition

Identifier for a person within a particular scope.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: .plays:Role(classCode='IDENT').id
Person.identifier:coordinationNumber.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.identifier:coordinationNumber.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.identifier:coordinationNumber.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Person.identifier:coordinationNumber.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

IdentifierTypeCodes (extensible)

SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
Person.identifier:coordinationNumber.system
ShortThe 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.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

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

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
http://electronichealth.se/identifier/samordningsnummer
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Person.identifier:coordinationNumber.value
ShortThe 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ident-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Person.identifier:coordinationNumber.period
ShortTime period when id is/was valid for use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Person.identifier:coordinationNumber.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Person.identifier:personalIdentityNumber
ShortA human identifier for this person
Definition

Identifier for a person within a particular scope.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • v2: PID-3
  • rim: .plays:Role(classCode='IDENT').id
Person.identifier:personalIdentityNumber.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.identifier:personalIdentityNumber.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.identifier:personalIdentityNumber.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Person.identifier:personalIdentityNumber.type
ShortDescription of identifier
Definition

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

Cardinality0..1
TypeCodeableConcept
Binding

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

IdentifierTypeCodes (extensible)

SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
Person.identifier:personalIdentityNumber.system
ShortThe 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.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

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

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
http://electronichealth.se/identifier/personnummer
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Person.identifier:personalIdentityNumber.value
ShortThe 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ident-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Person.identifier:personalIdentityNumber.period
ShortTime period when id is/was valid for use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Person.identifier:personalIdentityNumber.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Person.active
ShortThis person's record is in active use
Definition

Whether this person's record is in active use.

Cardinality0..1
Typeboolean
ModifierTrue
SummaryTrue
Requirements

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: statusCode
Person.name
ShortName 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.

Cardinality1..1
TypeNPPRHumanName
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN
  • rim: EN (actually, PN)
  • servd: ProviderName
  • v2: PID-5, PID-9
  • rim: ./name
Person.name.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.name.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.name.extension:middleName
ShortOptional Extensions Element
Definition

Extension for HumanName to express middle names.

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.name.use
Shortusual | official | temp | nickname | anonymous | old | maiden
Definition

Identifies the purpose for this name.

Cardinality0..1
Typecode
Binding

The use of a human name.

NameUse (required)

ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.7, but often indicated by which field contains the name
  • rim: unique(./use)
  • servd: ./NamePurpose
Person.name.text
ShortText 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.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: implied by XPN.11
  • rim: ./formatted
Person.name.family
ShortFamily 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.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Aliassurname
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.1/FN.1
  • rim: ./part[partType = FAM]
  • servd: ./FamilyName
  • NPPRPersonToNPPRPersonLogical: efternamn
Person.name.given
ShortGiven names (not always 'first'). Includes middle names
Definition

Given name.

Cardinality1..*
Typestring
Must SupportTrue
SummaryTrue
Aliasfirst 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.2 + XPN.3
  • rim: ./part[partType = GIV]
  • servd: ./GivenNames
  • NPPRPersonToNPPRPersonLogical: fornamn
Person.name.given.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.name.given.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.name.given.extension:nameQualifier
ShortLS | 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.

Cardinality0..1
TypeExtension(code)
Must SupportTrue
Aliasextensions, user content
Comments

Used to indicate additional information about the name part and how it should be used.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • rim: ENXP.qualifier
  • NPPRPersonToNPPRPersonLogical: mellannamn
  • NPPRPersonToNPPRPersonLogical: tilltalsnamnsmarkering
Person.name.given.value
ShortPrimitive value for string
Definition

Primitive value for string

Cardinality0..1
TypeSystem.String
Maximum string length1048576
Person.name.prefix
ShortParts 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.

Cardinality0..*
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.5
  • rim: ./part[partType = PFX]
  • servd: ./TitleCode
Person.name.suffix
ShortParts 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.

Cardinality0..*
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN/4
  • rim: ./part[partType = SFX]
Person.name.period
ShortTime period when name was/is in use
Definition

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

Cardinality0..1
TypePeriod
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: XPN.13 + XPN.14
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
Person.telecom
ShortDetails 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.

Cardinality0..*
TypeNPPRContactPoint
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cpt-2: A system is required if a value is provided.
    value.empty() or system.exists()
  • nppr-telecom-phone-1: If telecom.system = #phone, value should follow format +46123456789
    value.matches('^\\+[1-9][0-9]+$') or system != 'phone'
  • nppr-telecom-url-1: If telecom.system = #url, value should follow valid format. Example: https://example.com
    value.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url'
  • nppr-telecom-email-1: 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'
Mappings
  • rim: n/a
  • v2: XTN
  • rim: TEL
  • servd: ContactPoint
  • v2: PID-13, PID-14
  • rim: ./telecom
Person.gender
Shortmale | female | other | unknown
Definition

Administrative Gender.

Cardinality1..1
Typecode
Binding

The gender of a person used for administrative purposes.

nppr-administrative-gender (required)

Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: PID-8
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
  • NPPRPersonToNPPRPersonLogical: kon
Person.birthDate
ShortThe date on which the person was born
Definition

The birth date for the person.

Cardinality1..1
Typedate
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: PID-7
  • rim: ./birthTime
  • NPPRPersonToNPPRPersonLogical: fodelsedatum
Person.deceased[x]
ShortIndicates if the individual is deceased or not
Definition

Indicates if the individual is deceased or not.

Cardinality0..1
Typeboolean | dateTime
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: PID-30 (bool) and PID-29 (datetime)
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
Person.address
ShortAn 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.

Cardinality0..*
TypeNPPRAddress
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD
  • rim: AD
  • servd: Address
  • v2: PID-11
  • rim: ./addr
  • NPPRPersonToNPPRPersonLogical: harAdressIFormAv(KontaktuppgiftLogical)
Person.address.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.address.extension
ShortAdditional 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.

Cardinality1..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.address.extension:officialAddressType
ShortOptional Extensions Element
Definition

Extension for Address to express official address type.

Cardinality1..1
TypeExtension(CodeableConcept)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.address.use
Shorthome | work | temp | old | billing - purpose of this address
Definition

The purpose of this address.

Cardinality0..1
Typecode
Binding

The use of an address (home / work / etc.).

AddressUse (required)

Must SupportTrue
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
home
Mappings
  • rim: n/a
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
Person.address.type
Shortpostal | 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.

Cardinality0..1
Typecode
Binding

The type of an address (physical / postal).

AddressType (required)

Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
both
Mappings
  • rim: n/a
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
Person.address.text
ShortText 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.

Cardinality0..1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
137 Nowhere Street, Erewhon 9132
Mappings
  • rim: n/a
  • v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
  • rim: ./formatted
  • vcard: address label parameter
Person.address.line
ShortStreet 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.

Cardinality0..*
Typestring
Must SupportTrue
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
137 Nowhere Street
Mappings
  • rim: n/a
  • v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
  • rim: AD.part[parttype = AL]
  • vcard: street
  • servd: ./StreetAddress (newline delimitted)
Person.address.line.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.address.line.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.address.line.extension:streetName
ShortstreetName
Definition

streetName.

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • rim: ADXP[partType=STR]
Person.address.line.extension:houseNumber
ShorthouseNumber
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.

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • rim: ADXP[partType=BNR]
Person.address.line.extension:postBox
ShortpostBox
Definition

A numbered box located in a post station.

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • rim: ADXP[partType=POB]
Person.address.line.value
ShortPrimitive value for string
Definition

Primitive value for string

Cardinality0..1
TypeSystem.String
Must SupportTrue
Maximum string length1048576
Person.address.city
ShortName of city, town etc.
Definition

The name of the city, town, suburb, village or other community or delivery center.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
AliasMunicpality
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
Erewhon
Mappings
  • rim: n/a
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
Person.address.district
ShortDistrict name (aka county)
Definition

The name of the administrative area (county).

Cardinality0..1
Typestring
SummaryTrue
AliasCounty
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
Madison
Mappings
  • rim: n/a
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
Person.address.state
ShortSub-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).

Cardinality0..1
Typestring
SummaryTrue
AliasProvince, Territory
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.4
  • rim: AD.part[parttype = STA]
  • vcard: region
  • servd: ./Region
Person.address.postalCode
ShortPostal code for area
Definition

A postal code designating a region defined by the postal service.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
AliasZip
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
9132
Mappings
  • rim: n/a
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
Person.address.country
ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
Definition

Country - a nation as commonly understood or generally accepted.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Comments

ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.6
  • rim: AD.part[parttype = CNT]
  • vcard: country
  • servd: ./Country
Person.address.country.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.address.country.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.address.country.extension:countryCode
Shortcode for string
Definition

Provides a coded expression for the content represented in a string.

Cardinality0..1
TypeExtension(Coding)
Must SupportTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • rim: SC.code
Person.address.country.extension:countryCode.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.address.country.extension:countryCode.extension
ShortAdditional 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.

Cardinality0..0
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.address.country.extension:countryCode.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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
  • rim: N/A
Person.address.country.extension:countryCode.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
TypeCoding
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.

Iso316612 (preferred)

ConditionsThe cardinality or value of this element may be affected by these constraints: ext-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Person.address.country.value
ShortPrimitive value for string
Definition

Primitive value for string

Cardinality0..1
TypeSystem.String
Maximum string length1048576
Person.address.period
ShortTime period when address was/is in use
Definition

Time period when address was/is in use.

Cardinality1..1
TypePeriod
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
ExamplesGeneral
{
  "start": "2010-03-23",
  "end": "2010-07-01"
}
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: XAD.12 / XAD.13 + XAD.14
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
Person.address.period.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.address.period.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.address.period.start
ShortStarting time with inclusive boundary
Definition

The start of the period. The boundary is inclusive.

Cardinality1..1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

If the low element is missing, the meaning is that the low boundary is not known.

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: DR.1
  • rim: ./low
Person.address.period.end
ShortEnd 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.

Cardinality0..1
TypedateTime
Must SupportTrue
SummaryTrue
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

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: DR.2
  • rim: ./high
Person.maritalStatus
ShortMarital (civil) status of a person
Definition

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

Cardinality1..1
TypeCodeableConcept
Binding

The domestic partnership status of a person.

nppr-marital-status (extensible)

Must SupportTrue
Comments

Many countries maintain a register of births, deaths and marriages, and this would simplify that interaction

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: PID-16
  • rim: player[classCode=PSN]/maritalStatusCode
  • NPPRPersonToNPPRPersonLogical: civilstand
Person.maritalStatus.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.maritalStatus.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.maritalStatus.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality1..1
TypeCoding
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
    code.exists().not() implies display.exists().not()
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Person.maritalStatus.coding.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.maritalStatus.coding.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.maritalStatus.coding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Person.maritalStatus.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Person.maritalStatus.coding.code
ShortSymbol 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).

Cardinality1..1
Typecode
Must SupportTrue
SummaryTrue
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

ConditionsThe cardinality or value of this element may be affected by these constraints: cod-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Person.maritalStatus.coding.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
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

ConditionsThe cardinality or value of this element may be affected by these constraints: cod-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Person.maritalStatus.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Person.maritalStatus.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Person.photo
ShortImage of the person
Definition

An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.

Cardinality0..*
TypeAttachment
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If the Attachment has data, it SHALL have a contentType
    data.empty() or contentType.exists()
Mappings
  • rim: n/a
  • v2: ED/RP
  • rim: ED
  • v2: OBX-5 - needs a profile
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
Person.communication
ShortA 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.

Cardinality0..*
TypeBackboneElement
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: LanguageCommunication
Person.communication.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.communication.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.communication.modifierExtension
ShortExtensions 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.communication.language
ShortThe 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.

Cardinality1..1
TypeCodeableConcept
Binding

IETF language tag for a human language

AllLanguages (required)

Additional bindings
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: PID-15, LAN-2
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
Person.communication.preferred
ShortLanguage preference indicator
Definition

Indicates whether or not the person prefers this language (over other languages he masters up a certain level).

Cardinality0..1
Typeboolean
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: PID-15
  • rim: preferenceInd
Person.managingOrganization
ShortThe organization that is the custodian of the person record
Definition

The organization that is the custodian of the person record.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: scoper
Person.link
ShortLink to a resource that concerns the same actual person
Definition

Link to a resource that concerns the same actual person.

Cardinality0..*
TypeBackboneElement
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: outboundLink
Person.link.id
ShortUnique 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.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Person.link.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.link.modifierExtension
ShortExtensions 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Person.link.target
ShortThe resource to which this actual person is associated
Definition

The resource to which this actual person is associated.

Cardinality1..1
TypeReference(NPPRPatient | NPPRPractitioner | NPPRRelatedPerson)
Must SupportTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: id
  • NPPRPersonToNPPRPersonLogical: harDetaljeradeUppgifterI(VardOchOmsorgstagareLogical)
Person.link.assurance
Shortlevel1 | level2 | level3 | level4
Definition

Level of assurance that this link is associated with the target resource.

Cardinality0..1
Typecode
Binding

The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

IdentityAssuranceLevel (required)

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: priorityNumber?
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="NPPRPerson" />
<url value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson" />
<version value="0.1" />
<name value="NPPRPerson" />
<status value="active" />
<description value="Profile for representing basic data about an individual, comparable to data in the population registry (folkbokföring)." />
<fhirVersion value="5.0.0" />
<identity value="NPPRPersonToNPPRPersonLogical" />
<uri value="NPPRPersonLogical" />
</mapping>
<kind value="resource" />
<abstract value="false" />
<type value="Person" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Person" />
<derivation value="constraint" />
<element id="Person.meta">
<path value="Person.meta" />
<mustSupport value="true" />
</element>
<element id="Person.meta.security">
<path value="Person.meta.security" />
<mustSupport value="true" />
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="sekretessmarkering" />
</mapping>
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="skyddadFolkbokforing" />
</mapping>
</element>
<element id="Person.meta.security.code">
<path value="Person.meta.security.code" />
<mustSupport value="true" />
</element>
<element id="Person.identifier">
<path value="Person.identifier" />
<type value="value" />
<path value="system" />
</discriminator>
<description value="Slice on Identifier based on the system value" />
<ordered value="false" />
<rules value="open" />
</slicing>
<min value="1" />
<max value="1" />
<mustSupport value="true" />
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="person-id" />
</mapping>
</element>
<element id="Person.identifier.system">
<path value="Person.identifier.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Person.identifier.value">
<path value="Person.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Person.identifier:coordinationNumber">
<path value="Person.identifier" />
<sliceName value="coordinationNumber" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Person.identifier:coordinationNumber.system">
<path value="Person.identifier.system" />
<patternUri value="http://electronichealth.se/identifier/samordningsnummer" />
</element>
<element id="Person.identifier:coordinationNumber.value">
<path value="Person.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Person.identifier:personalIdentityNumber">
<path value="Person.identifier" />
<sliceName value="personalIdentityNumber" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Person.identifier:personalIdentityNumber.system">
<path value="Person.identifier.system" />
<patternUri value="http://electronichealth.se/identifier/personnummer" />
</element>
<element id="Person.identifier:personalIdentityNumber.value">
<path value="Person.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Person.name">
<path value="Person.name" />
<min value="1" />
<max value="1" />
<code value="HumanName" />
<profile value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRHumanName" />
</type>
<mustSupport value="true" />
</element>
<element id="Person.name.family">
<path value="Person.name.family" />
<min value="1" />
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="efternamn" />
</mapping>
</element>
<element id="Person.name.given">
<path value="Person.name.given" />
<min value="1" />
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="fornamn" />
</mapping>
</element>
<element id="Person.name.given.extension:nameQualifier">
<path value="Person.name.given.extension" />
<sliceName value="nameQualifier" />
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="mellannamn" />
</mapping>
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="tilltalsnamnsmarkering" />
</mapping>
</element>
<element id="Person.telecom">
<path value="Person.telecom" />
<code value="ContactPoint" />
<profile value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRContactPoint" />
</type>
<key value="nppr-telecom-phone-1" />
<severity value="warning" />
<human value="If telecom.system = #phone, value should follow format +46123456789" />
<expression value="value.matches('^\\+[1-9][0-9]+$') or system != 'phone'" />
<source value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson" />
</constraint>
<key value="nppr-telecom-url-1" />
<severity value="warning" />
<human value="If telecom.system = #url, value should follow valid format. Example: https://example.com" />
<expression value="value.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url'" />
<source value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson" />
</constraint>
<key value="nppr-telecom-email-1" />
<severity value="warning" />
<human value="If telecom.system = #email, value should follow valid format Example: test@test.com" />
<expression value="value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email'" />
<source value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Person.gender">
<path value="Person.gender" />
<min value="1" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://electronichealth.se/fhir/NPPR/ValueSet/nppr-administrative-gender" />
</binding>
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="kon" />
</mapping>
</element>
<element id="Person.birthDate">
<path value="Person.birthDate" />
<min value="1" />
<mustSupport value="true" />
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="fodelsedatum" />
</mapping>
</element>
<element id="Person.address">
<path value="Person.address" />
<code value="Address" />
<profile value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRAddress" />
</type>
<mustSupport value="true" />
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="harAdressIFormAv(KontaktuppgiftLogical)" />
</mapping>
</element>
<element id="Person.address.extension">
<path value="Person.address.extension" />
<min value="1" />
</element>
<element id="Person.address.extension:officialAddressType">
<path value="Person.address.extension" />
<sliceName value="officialAddressType" />
<min value="1" />
</element>
<element id="Person.maritalStatus">
<path value="Person.maritalStatus" />
<min value="1" />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="http://electronichealth.se/fhir/NPPR/ValueSet/nppr-marital-status" />
</binding>
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="civilstand" />
</mapping>
</element>
<element id="Person.maritalStatus.coding">
<path value="Person.maritalStatus.coding" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Person.maritalStatus.coding.system">
<path value="Person.maritalStatus.coding.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Person.maritalStatus.coding.code">
<path value="Person.maritalStatus.coding.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Person.link">
<path value="Person.link" />
<mustSupport value="true" />
</element>
<element id="Person.link.target">
<path value="Person.link.target" />
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy">
<valueBoolean value="false" />
</extension>
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPatient" />
<targetProfile value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPractitioner" />
<targetProfile value="http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRRelatedPerson" />
</type>
<mustSupport value="true" />
<identity value="NPPRPersonToNPPRPersonLogical" />
<map value="harDetaljeradeUppgifterI(VardOchOmsorgstagareLogical)" />
</mapping>
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "NPPRPerson",
"url": "http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson",
"version": "0.1",
"name": "NPPRPerson",
"status": "active",
"description": "Profile for representing basic data about an individual, comparable to data in the population registry (folkbokföring).",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"uri": "NPPRPersonLogical"
}
],
"kind": "resource",
"abstract": false,
"type": "Person",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Person",
"derivation": "constraint",
"element": [
{
"id": "Person.meta",
"path": "Person.meta",
"mustSupport": true
},
{
"id": "Person.meta.security",
"path": "Person.meta.security",
"mustSupport": true,
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "sekretessmarkering"
},
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "skyddadFolkbokforing"
}
]
},
{
"id": "Person.meta.security.code",
"path": "Person.meta.security.code",
"mustSupport": true
},
{
"id": "Person.identifier",
"path": "Person.identifier",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"description": "Slice on Identifier based on the system value",
"ordered": false,
"rules": "open"
},
"min": 1,
"max": "1",
"mustSupport": true,
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "person-id"
}
]
},
{
"id": "Person.identifier.system",
"path": "Person.identifier.system",
"min": 1,
"mustSupport": true
},
{
"id": "Person.identifier.value",
"path": "Person.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Person.identifier:coordinationNumber",
"path": "Person.identifier",
"sliceName": "coordinationNumber",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Person.identifier:coordinationNumber.system",
"path": "Person.identifier.system",
"patternUri": "http://electronichealth.se/identifier/samordningsnummer"
},
{
"id": "Person.identifier:coordinationNumber.value",
"path": "Person.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Person.identifier:personalIdentityNumber",
"path": "Person.identifier",
"sliceName": "personalIdentityNumber",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Person.identifier:personalIdentityNumber.system",
"path": "Person.identifier.system",
"patternUri": "http://electronichealth.se/identifier/personnummer"
},
{
"id": "Person.identifier:personalIdentityNumber.value",
"path": "Person.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Person.name",
"path": "Person.name",
"min": 1,
"max": "1",
"type": [
{
"code": "HumanName",
"profile": [
"http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRHumanName"
]
}
],
"mustSupport": true
},
{
"id": "Person.name.family",
"path": "Person.name.family",
"min": 1,
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "efternamn"
}
]
},
{
"id": "Person.name.given",
"path": "Person.name.given",
"min": 1,
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "fornamn"
}
]
},
{
"id": "Person.name.given.extension:nameQualifier",
"path": "Person.name.given.extension",
"sliceName": "nameQualifier",
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "mellannamn"
},
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "tilltalsnamnsmarkering"
}
]
},
{
"id": "Person.telecom",
"path": "Person.telecom",
"type": [
{
"code": "ContactPoint",
"profile": [
"http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRContactPoint"
]
}
],
{
"key": "nppr-telecom-phone-1",
"severity": "warning",
"human": "If telecom.system = #phone, value should follow format +46123456789",
"expression": "value.matches('^\\\\+[1-9][0-9]+$') or system != 'phone'",
"source": "http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson"
},
{
"key": "nppr-telecom-url-1",
"severity": "warning",
"human": "If telecom.system = #url, value should follow valid format. Example: https://example.com",
"expression": "value.matches('(https?|ftp)://(-\\\\.)?([^\\\\s/?\\\\.#-]+\\\\.?)+(/[^\\\\s]*)?$') or system != 'url'",
"source": "http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson"
},
{
"key": "nppr-telecom-email-1",
"severity": "warning",
"human": "If telecom.system = #email, value should follow valid format Example: test@test.com",
"expression": "value.matches('^[\\\\w.-]{1,64}@(?!.{254})[\\\\w.-]+\\\\.[A-Za-z]{2,4}$') or system != 'email'",
"source": "http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson"
}
],
"mustSupport": true
},
{
"id": "Person.gender",
"path": "Person.gender",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/NPPR/ValueSet/nppr-administrative-gender"
},
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "kon"
}
]
},
{
"id": "Person.birthDate",
"path": "Person.birthDate",
"min": 1,
"mustSupport": true,
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "fodelsedatum"
}
]
},
{
"id": "Person.address",
"path": "Person.address",
"type": [
{
"code": "Address",
"profile": [
"http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRAddress"
]
}
],
"mustSupport": true,
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "harAdressIFormAv(KontaktuppgiftLogical)"
}
]
},
{
"id": "Person.address.extension",
"path": "Person.address.extension",
"min": 1
},
{
"id": "Person.address.extension:officialAddressType",
"path": "Person.address.extension",
"sliceName": "officialAddressType",
"min": 1
},
{
"id": "Person.maritalStatus",
"path": "Person.maritalStatus",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://electronichealth.se/fhir/NPPR/ValueSet/nppr-marital-status"
},
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "civilstand"
}
]
},
{
"id": "Person.maritalStatus.coding",
"path": "Person.maritalStatus.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Person.maritalStatus.coding.system",
"path": "Person.maritalStatus.coding.system",
"min": 1,
"mustSupport": true
},
{
"id": "Person.maritalStatus.coding.code",
"path": "Person.maritalStatus.coding.code",
"min": 1,
"mustSupport": true
},
{
"id": "Person.link",
"path": "Person.link",
"mustSupport": true
},
{
"id": "Person.link.target",
"path": "Person.link.target",
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": false
}
],
"code": "Reference",
"http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPatient",
"http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPractitioner",
"http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRRelatedPerson"
]
}
],
"mustSupport": true,
"mapping": [
{
"identity": "NPPRPersonToNPPRPersonLogical",
"map": "harDetaljeradeUppgifterI(VardOchOmsorgstagareLogical)"
}
]
}
]
}
}

Constraints

PathIdGradeDetailsExpression
Person.telecomnppr-telecom-phone-1warningIf telecom.system = #phone, value should follow format +46123456789value.matches('^\\+[1-9][0-9]+$') or system != 'phone'
Person.telecomnppr-telecom-url-1warningIf telecom.system = #url, value should follow valid format. Example: https://example.comvalue.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url'
Person.telecomnppr-telecom-email-1warningIf telecom.system = #email, value should follow valid format Example: test@test.comvalue.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email'

Terminology Bindings

PathStrengthValueSet
Person.genderrequiredhttp://electronichealth.se/fhir/NPPR/ValueSet/nppr-administrative-gender
Person.maritalStatusextensiblehttp://electronichealth.se/fhir/NPPR/ValueSet/nppr-marital-status

Mapping

A mapping between this profile and the information model is shown below.

person-idC1..1Identifier
fornamn0..*string
efternamn1..1string
mellannamn0..1string
tilltalsnamnsmarkering1..1integer
konC1..1Coding
fodelsedatum1..1dateTime
sekretessmarkering1..1boolean
skyddadFolkbokforing1..1boolean
civilstandC1..1Coding
forsakringsmedlemsstatC0..1Coding
harAdressIFormAvC0..*Reference(NPPRKontaktuppgiftLogical)

Examples

Person with middle name

Person with middle name extension.

Person
{
"resourceType": "Person",
"id": "e3c13bb1-236e-424c-a28e-e266be42b073",
"meta": {
"profile": [
"http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson"
]
},
"text": {
"status": "additional",
--- We have skipped the narrative for better readability of the resource ---
},
{
"system": "http://electronichealth.se/identifier/samordningsnummer",
"value": "191605862398"
}
],
"name": [
{
{
"url": "http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRMiddleNameExtension",
"valueString": "Stefan"
}
],
"family": "Johansson",
"given": [
"Jimmy"
]
}
],
"gender": "male",
"birthDate": "1916-05-26",
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M"
}
]
}
}

Person with link reference to Patient instance, to explain that the Person and the Patient instances regard the same person.

Person
{
"resourceType": "Person",
"id": "b70186fb-432d-4077-a085-73d09107055b",
"meta": {
"profile": [
"http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPerson"
],
{
"system": "http://hl7.se/fhir/ig/base/CodeSystem/SecurityLabel",
"code": "sekretessmarkering",
"display": "Sekretessmarkering"
}
]
},
"text": {
"status": "additional",
--- We have skipped the narrative for better readability of the resource ---
},
{
"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",
"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"
}
},
{
"system": "email",
"value": "anna.svensson@example.org",
"period": {
"start": "2015-02-07T13:28:17.239+02:00"
}
}
],
"gender": "female",
"birthDate": "1916-05-26",
"address": [
{
{
"url": "http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPROfficialAddressTypeExtension",
"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"
}
}
],
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married"
}
]
},
"link": [
{
"target": {
"reference": "Patient/6d493572-0375-40a7-97eb-6a91ee7f72a0"
}
}
]
}