DIPSPerson - Definitions - DIPS Core Implementation Guide v0.1.0

Is Modifier false

Summary true

4. Person.meta

Definition

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

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Person.meta.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

8. Person.meta.extension

Definition

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

Short Additional content defined by implementations

Comments

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

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

Invariants 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())

This element introduces a set of slices on Person.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

10. Person.meta.versionId

Definition

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

Short Version specific identifier

Comments

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

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Person.meta.lastUpdated

Definition

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

Short When the resource version last changed

Comments

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

Control 0..1

instant

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

14. Person.meta.source

Definition

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

Short Identifies where the resource comes from

Comments

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

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

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

16. Person.meta.profile

Definition

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

Short Profiles this resource claims to conform to

Comments

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

Control 0..*

Type canonical(StructureDefinition)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

18. Person.meta.security

Definition

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

Short Security Labels applied to this resource

Comments

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

Control 0..*

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

Security Labels from the Healthcare Privacy and Security Classification System.

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Person.meta.security. The slices areUnordered and Open, and can be differentiated using the following discriminators:

exists @ system

20. Person.meta.security:addressConfidentiality

Slice Name addressConfidentiality

Definition

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

Short Security Labels applied to this resource

Comments

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

Control 0..*

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

Security Labels from the Healthcare Privacy and Security Classification System.

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

22. Person.meta.security:addressConfidentiality.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

24. Person.meta.security:addressConfidentiality.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Person.meta.security.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

26. Person.meta.security:addressConfidentiality.system

Definition

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

Short Identity of the terminology system

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 reference to some definition that establishes the system clearly and unambiguously.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Fixed Value http://ehelse.no/fhir/CodeSystem/gd-address-confidentiality

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

28. Person.meta.security:addressConfidentiality.version

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.

Short Version of the system - if relevant

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.

Note This is a business version Id, not a resource version Id (see discussion)

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

30. Person.meta.security:addressConfidentiality.code

Definition

nivå av beskyttelsesgrad på informasjon Gyldige kodeverdier er: • ugradert • fortrolig • strengtFortrolig (strengt fortrolig)

Short graderingsnivå from FREG

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to refer to a particular code in the system.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

32. Person.meta.security:addressConfidentiality.display

Definition

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

Short Representation defined by the system

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

34. Person.meta.security:addressConfidentiality.userSelected

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Short If this coding was chosen directly by the user

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

36. Person.meta.tag

Definition

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

Short Tags applied to this resource

Comments

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

Control 0..*

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

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

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

38. Person.implicitRules

Definition

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

Short A set of rules under which this content was created

Comments

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

Control 0..1

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

40. Person.language

Definition

The base language in which the resource is written.

Short Language of the resource content

Comments

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

Control 0..1

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

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

42. Person.text

Definition

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

Short Text summary of the resource, for human interpretation

Comments

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

Control 0..1

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

44. Person.contained

Definition

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

Short Contained, inline Resources

Comments

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

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

46. Person.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Person.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

48. Person.extension:language

Slice Name language

Definition

Optional Extension Element - found in all resources.

Short Optional Extensions Element

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(DIPSPersonLanguage) (Extension Type: Coding)

Is Modifier false

Summary false

50. Person.extension:language.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

52. Person.extension:language.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Person.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

54. Person.extension:language.url

Definition

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

Short identifies the meaning of the extension

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.

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://dips.no/fhir/R4/StructureDefinition/DIPSPersonLanguage

56. Person.extension:language.value[x]

Definition

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

Short Value of extension

Control 0..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

58. Person.extension:language.value[x].id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

60. Person.extension:language.value[x].extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Person.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

62. Person.extension:language.value[x].system

Definition

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

Short Identity of the terminology system

Comments

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Fixed Value urn:oid:1.3.6.1.4.1.9038.52.1587

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

64. Person.extension:language.value[x].version

Definition

Short Version of the system - if relevant

Comments

Note This is a business version Id, not a resource version Id (see discussion)

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

66. Person.extension:language.value[x].code

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).

Short Symbol in syntax defined by the system

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to refer to a particular code in the system.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

68. Person.extension:language.value[x].display

Definition

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

Short Representation defined by the system

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

70. Person.extension:language.value[x].userSelected

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Short If this coding was chosen directly by the user

Comments

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

72. Person.extension:deathRegisteredTime

Slice Name deathRegisteredTime

Definition

Optional Extension Element - found in all resources.

Short Optional Extensions Element

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(DIPSPersonDeathRegisteredTime) (Extension Type: dateTime)

Is Modifier false

Summary false

74. Person.extension:deathComment

Slice Name deathComment

Definition

Optional Extension Element - found in all resources.

Short Optional Extensions Element

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(DIPSPersonDeathComment) (Extension Type: string)

Is Modifier false

Summary false

76. Person.extension:deathRegisteredBy

Slice Name deathRegisteredBy

Definition

Optional Extension Element - found in all resources.

Short Optional Extensions Element

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(DIPSPersonDeathRegisteredBy) (Extension Type: string)

Is Modifier false

Summary false

78. Person.extension:hospitalSectorId

Slice Name hospitalSectorId

Definition

Optional Extension Element - found in all resources.

Short Optional Extensions Element

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(DIPSPersonHospitalSectorId) (Extension Type: id)

Is Modifier false

Summary false

80. Person.extension:hospitalSectorName

Slice Name hospitalSectorName

Definition

Optional Extension Element - found in all resources.

Short Optional Extensions Element

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(DIPSPersonHospitalSectorName) (Extension Type: string)

Is Modifier false

Summary false

82. Person.modifierExtension

Definition

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

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

Short Extensions that cannot be ignored

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

Requirements

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

Alternate Names extensions, user content

84. Person.identifier

Definition

An identifier for this person. Should be at Fødselsnummer or D-nummer

Identifier for a person within a particular scope.

Short A human identifier for this person

Note This is a business identifier, not a resource identifier (see discussion)

Control 1..*

Is Modifier false

Summary false

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Person.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ system

86. Person.identifier.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

88. Person.identifier.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Person.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

90. Person.identifier.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

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

Control 0..1

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

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

92. Person.identifier.type

Definition

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

Short Description of identifier

Comments

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

Control 0..0

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

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

Is Modifier false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

94. Person.identifier.system

Definition

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

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

96. Person.identifier.value

Definition

The Norwegian Fødselsnummer

Short The value that is unique

Comments

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

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

98. Person.identifier.period

Definition

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

Short Time period when id is/was valid for use

Control 0..0

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

100. Person.identifier.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

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

Control 0..0

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

102. Person.identifier:FNR

Slice Name FNR

Definition

Fødselsnummer for the patient. Fødselsnummer as one of the possible patient identifier, should at least be sent unless there is a reason not to. Reasons for not sending the Fødselsnummer include but are not limited to, research and apps without a contract for processing data.

Multiple FNR can exist for a person. If several FNR is provided the time period that each identifier is valid should be provided. No information about period is required when only one FNR is provided.

Short Norwegian FNR

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Is Modifier false

Summary false

Requirements

Alternate Names fødselsnummer

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

104. Person.identifier:FNR.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

106. Person.identifier:FNR.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Person.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

108. Person.identifier:FNR.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

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

Control 0..1

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

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

110. Person.identifier:FNR.type

Definition

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

Short Description of identifier

Comments

Control 0..0

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

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

Is Modifier false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

112. Person.identifier:FNR.system

Definition

Identifies that this is a Norwegian Fødselsnummer

Short Identification of the Norwegian FNR

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Fixed Value urn:oid:2.16.578.1.12.4.1.4.1

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

114. Person.identifier:FNR.value

Definition

The Norwegian Fødselsnummer

Short The value that is unique

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names fødselsnummer

Example General: 123456
Fødselsnummer: 15076500565

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

116. Person.identifier:FNR.period

Definition

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

Short Time period when id is/was valid for use

Control 0..0

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

118. Person.identifier:FNR.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

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

Control 0..0

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

120. Person.identifier:DNR

Slice Name DNR

Definition

The D-nummer of the patient. (assigned by the norwegian Skatteetaten)

Short The D-nummer of the patient

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Is Modifier false

Summary false

Requirements

Alternate Names D-nummer

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

122. Person.identifier:DNR.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

124. Person.identifier:DNR.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Person.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

126. Person.identifier:DNR.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

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

Control 0..1

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

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

128. Person.identifier:DNR.type

Definition

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

Short Description of identifier

Comments

Control 0..0

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

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

Is Modifier false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

130. Person.identifier:DNR.system

Definition

The identification of the Norwegian D-nummer

Short The identification of the D-nummer

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Fixed Value urn:oid:2.16.578.1.12.4.1.4.2

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

132. Person.identifier:DNR.value

Definition

The actual Norwegian D-nummer

Short The value that is unique

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: 123456
D-nummer: 700199 50032

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

134. Person.identifier:DNR.period

Definition

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

Short Time period when id is/was valid for use

Control 0..0

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

136. Person.identifier:DNR.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

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

Control 0..0

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

138. Person.identifier:PersonID

Slice Name PersonID

Definition

An identifier for this person. Should be at Fødselsnummer or D-nummer

Identifier for a person within a particular scope.

Short A human identifier for this person

Note This is a business identifier, not a resource identifier (see discussion)

Control 1..1

Is Modifier false

Summary false

Requirements

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

140. Person.identifier:PersonID.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

142. Person.identifier:PersonID.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Person.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

144. Person.identifier:PersonID.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

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

Control 0..0

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

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

146. Person.identifier:PersonID.type

Definition

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

Short Description of identifier

Comments

Control 0..1

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

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

Is Modifier false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

148. Person.identifier:PersonID.system

Definition

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

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Fixed Value http://dips.no/fhir/namingsystem/dips-personid

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

150. Person.identifier:PersonID.value

Definition

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

Short The value that is unique

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

152. Person.identifier:PersonID.period

Definition

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

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

154. Person.identifier:PersonID.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

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

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

156. Person.name

Definition

A name associated with the person.

Short A name associated with the person

Comments

Person may have multiple names with different uses or applicable periods.

Control 0..*

Type HumanName(no-basis-HumanName)

Is Modifier false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

158. Person.name.id

Definition

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

Short Unique id for inter-element referencing

Control 0..0

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

160. Person.name.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Person.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

162. Person.name.extension:middlename

Slice Name middlename

Definition

Defines a middle name as a specific extension as this is widely used in Norwegian names. The middlename is defined in norwegian legislation (lov om personnavn).

Short Defines a middle name

Control 0..*

Type Extension(no-basis-middlename) (Extension Type: string)

Is Modifier false

Summary false

164. Person.name.use

Definition

Identifies the purpose for this name.

Comments

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

Control 0..0

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

The use of a human name.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

166. Person.name.text

Definition

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

Short Text representation of the full name

Comments

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

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

168. Person.name.family

Definition

Ref. "lov om personnavn" for further details about Norwegian HumanNames.

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.

Short Family name (often called 'Surname')

Comments

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

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names surname, etternavn

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

170. Person.name.given

Definition

Given name. In Norway Given name does not include middlenames according to the regulation for norwegian names. Multiple given names are however legal. Ref. "Lov om personnavn" for further details about Norwegian HumanNames.

Short Given names (not always 'first')

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.

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names first name, middle name, fornavn

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

172. Person.name.prefix

Definition

This is not a part of official Norwegian names as defined in "lov om personnavn" regulation.

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.

Short Prefix is not used in Norwegian names

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

174. Person.name.suffix

Definition

This is not a part of official Norwegian names as defined in "lov om personnavn" regulation.

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.

Short Suffix is not used in Norwegian human names

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

176. Person.name.period

Definition

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

Short Time period when name was/is in use

Control 0..0

Is Modifier false

Summary true

Requirements

Allows names to be placed in historical context.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

178. Person.telecom

Definition

A contact detail for the person, e.g. a telephone number or an email address.

Short A contact detail for the person

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.

Control 0..*

ContactPoint

Is Modifier false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

180. Person.gender

Definition

Administrative Gender.

Short male | female | other | unknown

Comments

The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F.

Control 0..1

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

The gender of a person used for administrative purposes.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

182. Person.birthDate

Definition

The birth date for the person.

Short The date on which the person was born

Comments

At least an estimated year should be provided as a guess if the real DOB is unknown.

Control 0..1

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

184. Person.address

Definition

http://hl7.no/fhir/StructureDefinition/no-basis-Address

Short Norwegian address

Comments

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

Control 0..*

Type Address(no-basis-Address)

Is Modifier false

Summary false

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

186. Person.address.id

Definition

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

database column -- dipscoredb.dwadresse.adresseid

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

188. Person.address.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Person.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

190. Person.address.extension:official

Slice Name official

Definition

Defines the concept of an officially registered address in Norway. Usually this will be the adress registered in "Folkeregisteret" for persons or "Enhetsregisteret" for organizations. database column -- dipscoredb.dwperson.fregoppdatering

Short The concept of an officially registered address

Control 0..*

Type Extension(no-basis-address-official) (Extension Type: boolean)

Is Modifier false

Summary false

192. Person.address.extension:urbanDistrict

Slice Name urbanDistrict

Definition

The name and number of the of the urban district of this address.

Short urban district information

Control 0..1

Type Extension(no-basis-urban-district) (Extension Type: Coding)

Is Modifier false

Summary false

194. Person.address.extension:propertyInformation

Slice Name propertyInformation

Definition

Identification of a real property in Norway is defined using gårdsnummer, bruksnummer and kommunenummer. In addition real property can be rented out, the area of the real property that is rented is measured and is further identified by its festenummer. In addition some real property is split into sections identified by its seksjonsnummer

Short Real property identification

Control 0..*

Type Extension(no-basis-propertyinformation) (Complex Extension)

Is Modifier false

196. Person.address.extension:stateName

Slice Name stateName

Definition

Optional Extension Element - found in all resources.

Short Optional Extensions Element

Control 0..1

Type Extension(DIPSPersonStateName) (Extension Type: string)

Is Modifier false

Summary false

198. Person.address.extension:lastOfficialAddressSyncTime

Slice Name lastOfficialAddressSyncTime

Definition

Optional Extension Element - found in all resources.

Short Optional Extensions Element

Control 0..1

Type Extension(DIPSPersonLastOfficialAddressSyncTime) (Extension Type: dateTime)

Is Modifier false

Summary false

200. Person.address.use

Definition

The purpose of this address.

Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false.

derive from database column -- dipscoredb.dwadresse.dipscadresse and dipscoredb.dwkodeverkverdier.Kode

Short home | work | temp | old | billing - purpose of this address

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from AddressUse
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows an appropriate address to be chosen from a list of many.

Example General: home

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

202. Person.address.type

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Short postal | physical | both

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).

Control 0..1

The codes SHALL be taken from AddressType
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

The type of an address (physical / postal).

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: both

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

204. Person.address.text

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.

Short Text representation of the address

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Example General: 137 Nowhere Street, Erewhon 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

206. Person.address.line

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

database column -- dipscoredb.dwadresse.dipscadresse

Short Street name, number, direction & P.O. Box etc.

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: 137 Nowhere Street

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

208. Person.address.city

Definition

When a postalcode is given the name of the city must be according to the official list of postalcodes used in Norway.

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

database column -- dipscoredb.dwkodeverkverdier.langtnavn

Short Poststed or city

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names Municpality, by, poststed

Example General: Erewhon

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

210. Person.address.district

Definition

Name of the county (norwegian "kommune"). If kommune number is required "eiendomsinformasjon" should be used.

The name of the administrative area (county).

database column -- dipscoredb.dwkodeverkverdier.langtnavn

Short name of "kommune"

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names County, kommune

Example General: Madison

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

212. Person.address.district.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

214. Person.address.district.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Person.address.district.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

216. Person.address.district.extension:municipalitycode

Slice Name municipalitycode

Definition

Coded value for municipality/county Norwegian kommune

Short Coded value for municipality/county Norwegian kommune

Control 0..1

Type Extension(no-basis-municipalitycode) (Extension Type: Coding)

Is Modifier false

Summary false

218. Person.address.district.extension:muniplaity

Slice Name muniplaity

Definition

Optional Extension Element - found in all resources.

Short Optional Extensions Element

Control 0..1

Type Extension(DIPSPersonMunicipality) (Extension Type: Coding)

Is Modifier false

Summary false

220. Person.address.district.extension:muniplaity.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

222. Person.address.district.extension:muniplaity.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Person.address.district.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

224. Person.address.district.extension:muniplaity.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://dips.no/fhir/R4/StructureDefinition/DIPSPersonMunicipality

226. Person.address.district.extension:muniplaity.value[x]

Definition

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

Short Value of extension

Control 0..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

228. Person.address.district.extension:muniplaity.value[x].id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

230. Person.address.district.extension:muniplaity.value[x].extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Person.address.district.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

232. Person.address.district.extension:muniplaity.value[x].system

Definition

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

Short Identity of the terminology system

Comments

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Fixed Value urn:oid:2.16.578.1.12.4.1.1.3402

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

234. Person.address.district.extension:muniplaity.value[x].version

Definition

Short Version of the system - if relevant

Comments

Note This is a business version Id, not a resource version Id (see discussion)

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

236. Person.address.district.extension:muniplaity.value[x].code

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).

Short Symbol in syntax defined by the system

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to refer to a particular code in the system.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

238. Person.address.district.extension:muniplaity.value[x].display

Definition

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

Short Representation defined by the system

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

240. Person.address.district.extension:muniplaity.value[x].userSelected

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Short If this coding was chosen directly by the user

Comments

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

242. Person.address.district.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

244. Person.address.state

Definition

Name of the norwegian "fylke"). If fylkes-number is required "eiendomsinformasjon" should be used with koded kommune-number.

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).

database column -- dipscoredb.dwkodeverkverdier.kode

Short norwegian "fylke"

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names Province, Territory, fylke

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

246. Person.address.postalCode

Definition

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

In Norway this is af four digit number defined by the norwegian postal service.

database column -- dipscoredb.dwkodeverkverdier.Kode

Short Postal code for area

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names Zip, postnummer

Example General: 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

248. Person.address.country

Definition

Country - a nation as commonly understood or generally accepted.

database column -- dipscoredb.dwkodeverkverdier.langtnavn

Short Country (e.g. can be ISO 3166 2 or 3 letter code)

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

250. Person.address.period

Definition

Time period when address was/is in use.

Short Time period when address was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows addresses to be placed in historical context.

Example General: { "start" : "2010-03-23", "end" : "2010-07-01" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

252. Person.address.period.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

254. Person.address.period.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Person.address.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

256. Person.address.period.start

Definition

The start of the period. The boundary is inclusive.

database column -- dipscoredb.dwadresse.Gyldigfradato

Short Starting time with inclusive boundary

Comments

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

Control 0..1
This element is affected by the following invariants: per-1

dateTime

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

258. Person.address.period.end

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.

Short End time with inclusive boundary, if not ongoing

Comments

The high 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.

Control 0..1
This element is affected by the following invariants: per-1

dateTime

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Meaning if Missing If the end of the period is missing, it means that the period is ongoing

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

260. Person.photo

Definition

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

Short Image of the person

Control 0..0

Attachment

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

262. Person.managingOrganization

Definition

The organization that is the custodian of the person record.

Short The organization that is the custodian of the person record

Control 0..0

Type Reference(Organization, no-basis-Organization)

Is Modifier false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

264. Person.active

Definition

Whether this person's record is in active use.

Short This person's record is in active use

Control 0..1

Is Modifier true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

266. Person.link

Definition

Link to a resource that concerns the same actual person.

Short Link to a resource that concerns the same actual person

Control 1..1

BackboneElement

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

268. Person.link.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

270. Person.link.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

272. Person.link.modifierExtension

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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

274. Person.link.target

Definition

The resource to which this actual person is associated.

Short The resource to which this actual person is associated

Control 1..1

Type Reference(Patient, Practitioner, RelatedPerson, Person)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

276. Person.link.assurance

Definition

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

Short level1 | level2 | level3 | level4

Control 0..1

The codes SHALL be taken from IdentityAssuranceLevel
(required to http://hl7.org/fhir/ValueSet/identity-assuranceLevel|4.0.1)

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