Astacus Cancer Patient Profile - Definitions - Implementation Guide for Astacus project v0.0.1

Is Modifier false

Summary true

4. Patient.meta

Definition

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

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. Patient.meta.id

Definition

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

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. Patient.meta.extension

Definition

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

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 Patient.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

10. Patient.meta.versionId

Definition

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

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. Patient.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. Patient.meta.source

Definition

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

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. Patient.meta.profile

Definition

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

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

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

value @ $this

18. Patient.meta.profile:fr-canonical

Slice Name fr-canonical

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

Type canonical(StructureDefinition)

Is Modifier false

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

Summary true

Pattern Value https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient

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

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

Security Labels from the Healthcare Privacy and Security Classification System.

Coding

Is Modifier false

Summary true

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

22. Patient.meta.tag

Definition

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

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)

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

Coding

Is Modifier false

Summary true

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

24. Patient.implicitRules

Definition

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

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

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

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

28. Patient.text

Definition

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

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

30. Patient.contained

Definition

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

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

32. Patient.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

34. Patient.extension:nationality

Slice Name nationality

Definition

The nationality of the patient.

Short Nationality

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

Type Extension(FR Core Nationality Extension) (Complex Extension)

Is Modifier false

36. Patient.extension:identityReliability

Slice Name identityReliability

Definition

Reliabilility of the patient's identity | Précision sur le degré de fiabilité de l'identité du patient (si provisoire, validé... avec la justification : quelle type de pièce d'identité ?) avec la méthode de collection

Short Reliabilility of the identity | Fiabilité de l'identité

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

Type Extension(FR Core Patient Ident Reliability Extension) (Complex Extension)

Is Modifier false

38. Patient.extension:deathPlace

Slice Name deathPlace

Definition

Carries the death place of the patient |Précise le lieu de décès du patient (hôpital, sur la voie publique, au domicile, etc.).

Short FR Core Patient Death Place Extension

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

Type Extension(FR Core Patient Death Place Extension) (Extension Type: string)

Is Modifier false

40. Patient.extension:birthdateUpdateIndicator

Slice Name birthdateUpdateIndicator

Definition

An Extension

Short FR Core Patient Birthdate Update Indicator Extension

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

Type Extension(FR Core Patient Birthdate Update Indicator Extension) (Extension Type: boolean)

Is Modifier false

42. Patient.extension:birthPlace

Slice Name birthPlace

Definition

The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

Short Place of Birth for patient

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

Type Extension(Patient Birth Place) (Extension Type: Address)

Is Modifier false

44. Patient.extension:birthPlace.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

46. Patient.extension:birthPlace.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

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

value @ url

48. Patient.extension:birthPlace.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://hl7.org/fhir/StructureDefinition/patient-birthPlace

50. Patient.extension:birthPlace.value[x]

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.

Short An address expressed using postal conventions (as opposed to GPS or other location definition formats)

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

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

Type Address(FR Core Address Profile)

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

Is Modifier false

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

52. Patient.modifierExtension

Definition

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

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

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

54. Patient.identifier

Definition

An identifier for this patient.

Short An identifier for this patient | Identifiant patient. Pour modéliser un patient avec une INS validée, il est nécessaire de respecter la conformité au profil FrCorePatientINS. Les identifiants NIR et NIA ne sont définis uniquement dans le cas du FRCorePatientINS.

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

Control 0..*

Is Modifier false

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

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 Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ type

56. Patient.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

58. Patient.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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

60. Patient.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()))

62. Patient.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..1

Binding Unless not suitable, these codes SHALL be taken from FR Core ValueSet Patient identifier type
(extensible to https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-identifier-type)

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

64. Patient.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()))

66. Patient.identifier.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

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

68. Patient.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..1

Is Modifier false

Summary true

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

70. Patient.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..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()))

72. Patient.identifier:NSS

Slice Name NSS

Definition

An identifier for this patient.

Short National Health Plan Identifier | Le Numéro d'Inscription au Répertoire (NIR) de facturation permet de faire transiter le numéro de sécurité social de l’ayant droit ou du bénéfiaire (patient) / le numéro de sécurité sociale de l’ouvrant droit (assuré).

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

Control 0..1

Is Modifier false

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

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

74. Patient.identifier:NSS.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

76. Patient.identifier:NSS.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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

78. Patient.identifier:NSS.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.

Pattern Value official

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

80. Patient.identifier:NSS.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 1..1

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

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.

Pattern Value { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "NH" }] }

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

82. Patient.identifier:NSS.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.

Pattern Value urn:oid:1.2.250.1.213.1.4.8

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

84. Patient.identifier:NSS.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()))

86. Patient.identifier:NSS.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()))

88. Patient.identifier:NSS.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()))

90. Patient.identifier:INS-C

Slice Name INS-C

Definition

An identifier for this patient.

Short Computed National Health Identifier | Identifiant National de Santé Calculé à partir des éléments de la carte vitale

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

Control 0..*

Is Modifier false

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

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

92. Patient.identifier:INS-C.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

94. Patient.identifier:INS-C.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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

96. Patient.identifier:INS-C.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.

Pattern Value secondary

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

98. Patient.identifier:INS-C.type

Definition

Computed National Health Identifier | Identifiant National de Santé Calculé à partir des éléments de la carte vitale

Short Description of identifier

Comments

Control 1..1

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

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.

Pattern Value { "coding" : [{ "system" : "https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203", "code" : "INS-C", "display" : "Identifiant National de Santé Calculé" }] }

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

100. Patient.identifier:INS-C.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.

Pattern Value urn:oid:1.2.250.1.213.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()))

102. Patient.identifier:INS-C.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()))

104. Patient.identifier:INS-C.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()))

106. Patient.identifier:INS-C.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()))

108. Patient.identifier:NDP

Slice Name NDP

Definition

An identifier for this patient.

Short French pharmaceutical Record Identifier | Numéro de Dossier Pharmaceutique français. Celui-ci est unique.

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

Control 0..1

Is Modifier false

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

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

110. Patient.identifier:NDP.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

112. Patient.identifier:NDP.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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

114. Patient.identifier:NDP.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.

Pattern Value secondary

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

116. Patient.identifier:NDP.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 1..1

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

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.

Pattern Value { "coding" : [{ "system" : "https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203", "code" : "NDP", "display" : "Identifiant du patient au Dossier Pharmaceutique" }] }

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

118. Patient.identifier:NDP.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.

Pattern Value urn:oid:1.2.250.1.176.1.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()))

120. Patient.identifier:NDP.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()))

122. Patient.identifier:NDP.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()))

124. Patient.identifier:NDP.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()))

126. Patient.identifier:PI

Slice Name PI

Definition

An identifier for this patient.

Short Hospital assigned patient identifier | IPP

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

Control 0..1

Is Modifier false

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

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

128. Patient.identifier:PI.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

130. Patient.identifier:PI.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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

132. Patient.identifier:PI.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.

Pattern Value usual

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

134. Patient.identifier:PI.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 1..1

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

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.

Pattern Value { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "PI", "display" : "Patient internal identifier" }] }

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

136. Patient.identifier:PI.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.

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

138. Patient.identifier:PI.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()))

140. Patient.identifier:PI.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()))

142. Patient.identifier:PI.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()))

144. Patient.identifier:RRI

Slice Name RRI

Definition

An identifier for this patient.

Short Regional Registry ID | Identifiant régional

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

Control 0..*

Is Modifier false

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

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

146. Patient.identifier:RRI.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

148. Patient.identifier:RRI.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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

150. Patient.identifier:RRI.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.

Pattern Value secondary

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

152. Patient.identifier:RRI.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 1..1

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

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.

Pattern Value { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "RRI", "display" : "Regional registry ID" }] }

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

154. Patient.identifier:RRI.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.

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

156. Patient.identifier:RRI.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()))

158. Patient.identifier:RRI.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()))

160. Patient.identifier:RRI.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()))

162. Patient.active

Definition

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

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

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

Short Whether this patient's record is in active use

Comments

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

Control 0..1

boolean

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 patient record as not to be used because it was created in error.

Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element

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

164. Patient.name

Definition

A name associated with the individual.

Short A name associated with the patient

Comments

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

Control 0..*

Type HumanName(FR Core Human Name Profile)

Is Modifier false

Summary true

Requirements

Need to be able to track the patient 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()))

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

value @ use

166. Patient.name:usualName

Slice Name usualName

Definition

A human's name with the ability to identify parts and usage | Le nom utilisé (usual) n’est transmis que s’il est défini (par exemple nom marital du conjoint).

Short Name of a human | Nom utilisé

Comments

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

Control 0..*

HumanName

Is Modifier false

Summary true

Requirements

Need to be able to track the patient 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()))

168. Patient.name:usualName.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

170. Patient.name:usualName.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 Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

172. Patient.name:usualName.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 1..1

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.

Pattern Value usual

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

174. Patient.name:usualName.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()))

176. Patient.name:usualName.family

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.

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

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

178. Patient.name:usualName.given

Definition

Given name.

Short Given names (not always 'first'). Includes middle names

Comments

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

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

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

180. Patient.name:usualName.prefix

Definition

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

Short Parts that come before the name

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

182. Patient.name:usualName.suffix

Definition

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

Short Parts that come after the name

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

184. Patient.name:usualName.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..1

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

186. Patient.name:officialName

Slice Name officialName

Definition

A human's name with the ability to identify parts and usage | Le nom de naissance (official) est obligatoire dans le cas où l’on véhicule l’INS et que l’identité est qualifiée (celui-ci ne doit pas être altéré).

Short Name of a human | Nom de naissance

Comments

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

Control 0..*

HumanName

Is Modifier false

Summary true

Requirements

Need to be able to track the patient 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()))

188. Patient.name:officialName.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

190. Patient.name:officialName.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 Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

192. Patient.name:officialName.extension:birth-list-given-name

Slice Name birth-list-given-name

Definition

Prénoms de l'acte de naissance

Short Dans le cas d’une identité créée ou modifiée par un appel au téléservice INSi, il s’agit de la liste des prénoms retournée par le téléservice. Ce composant contient tous les prénoms du patient, y compris le premier, que l'on retrouve également dans le champ name.given. Il s'agit de la liste des prénoms du patient, qu'elle soit issue d'une saisie locale ou du retour à l'appel au téléservice INSi. Conformément aux spécifications INS, cette liste est constituée des prénoms, séparés par des espaces.

Control 0..1

Type Extension(FR Core Patient Birth List Given name Extension) (Extension Type: string)

Is Modifier false

Summary false

194. Patient.name:officialName.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 1..1

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.

Pattern Value official

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

196. Patient.name:officialName.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()))

198. Patient.name:officialName.family

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.

Short Family name (often called 'Surname')

Comments

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

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 surname

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

200. Patient.name:officialName.given

Definition

Given name.

Short Given names (not always 'first'). Includes middle names

Comments

Control 1..*

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

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

202. Patient.name:officialName.prefix

Definition

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

Short Parts that come before the name

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

204. Patient.name:officialName.suffix

Definition

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

Short Parts that come after the name

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

206. Patient.name:officialName.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..1

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

208. Patient.telecom

Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Short Details of a Technology mediated contact point (phone, fax, email, etc.)

Comments

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

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

Type ContactPoint(FR Core Contact Point Profile)

Is Modifier false

Requirements

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

Invariants cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

210. Patient.gender

Definition

French patient's gender checked with the INSi teleservice | Genre du patient. Dans le cas d'une identité récupérée par le téléservice INSi, les valeurs sont M ou F

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 male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

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 individual, in combination with (at least) name and birth date.

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

212. Patient.birthDate

Definition

The date of birth for the individual.

Short The date of birth for the french patient checked with the INSitelservice | Date de naissance du patient. Dans le cas d'une identité récupérée du téléservice INSi, la date de naissance est modifiée selon les règles du RNIV dans le cas de dates exceptionnelles.

Comments

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

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 the individual drives many clinical processes.

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

LOINC Code 21112-8

214. Patient.deceased[x]

Definition

Indicates if the individual is deceased or not.

Short Indicates if the individual is deceased or not

Comments

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

Control 0..1

Type Choice of: boolean, dateTime

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

Is Modifier true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.

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

Must Support true

Must Support Types No must-support rules about the choice of types/profiles

Summary true

Requirements

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

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

216. Patient.address

Definition

Short An address expressed using postal conventions (as opposed to GPS or other location definition formats)

Comments

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

Type Address(FR Core Address Profile)

Is Modifier false

Requirements

May need to keep track of patient 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()))

218. Patient.maritalStatus

Definition

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

Short Marital (civil) status of a patient

Control 0..1

Binding Unless not suitable, these codes SHALL be taken from FR Core ValueSet Patient gender INS ValueSet
(extensible to https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-marital-status)

Is Modifier false

Summary false

Requirements

Most, if not all systems capture it.

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

220. Patient.multipleBirth[x]

Definition

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

Short Whether patient is part of a multiple birth

Comments

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

Control 0..1

Type Choice of: boolean, integer

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

Is Modifier false

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

Summary false

Requirements

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

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

222. Patient.photo

Definition

Image of the patient.

Short Image of the patient

Comments

Guidelines:

Use id photos, not clinical photos.
Limit dimensions to thumbnail.
Keep byte count low to ease resource updates.

Control 0..*

Attachment

Is Modifier false

Summary false

Requirements

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

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

224. Patient.contact

Definition

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

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

Comments

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

Control 0..*

BackboneElement

Is Modifier false

Summary false

Requirements

Need to track people you can contact about the patient.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())

226. Patient.contact.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

228. Patient.contact.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

230. Patient.contact.extension:contactIdentifier

Slice Name contactIdentifier

Definition

This extension carries the contact identifier in the patient resource | Ajout d'un identifiant de contact dans la ressource Patient

Short Contact identifier in the patient resource | Identifiant de contact dans la ressource Patient

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

Type Extension(FR Core Patient Contact Identifier Extension) (Extension Type: Identifier)

Is Modifier false

232. Patient.contact.extension:comment

Slice Name comment

Definition

add a comment on a dataElement of a resource | Ajout d'un commentaire sur un dataElement d'une ressource

Short Comment on a dataElement | Commentaire sur un dataElement

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

Type Extension(FR Core Comment Extension) (Extension Type: string)

Is Modifier false

234. Patient.contact.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

236. Patient.contact.relationship

Definition

The nature of the relationship between the patient and the contact person.

Short The kind of relationship

Control 0..*

Unless not suitable, these codes SHALL be taken from PatientContactRelationship
(extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

The nature of the relationship between a patient and a contact person for that patient.

Is Modifier false

Summary false

Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

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 Patient.contact.relationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ coding.system

238. Patient.contact.relationship:Role

Slice Name Role

Definition

The nature of the relationship between the patient and the contact person.

Short The nature of the relationship. Rôle de la personne. Ex : personne de confiance, aidant ...

Control 0..1

Binding Unless not suitable, these codes SHALL be taken from FR Core ValueSet Patient contact role
(extensible to https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-contact-role)

Is Modifier false

Summary false

Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

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

240. Patient.contact.relationship:RelationType

Slice Name RelationType

Definition

The nature of the relationship between the patient and the contact person.

Short The nature of the relationship. Relation de la personne. Ex : Mère, époux, enfant ...

Control 0..1

Binding Unless not suitable, these codes SHALL be taken from FR Core ValueSet relation type
(extensible to https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-relation-type)

Is Modifier false

Summary false

Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

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

242. Patient.contact.name

Definition

A human's name with the ability to identify parts and usage.

Short Name of a human - parts and usage

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.

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

Type HumanName(FR Core Human Name Profile)

Is Modifier false

Requirements

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

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

244. Patient.contact.telecom

Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Short Details of a Technology mediated contact point (phone, fax, email, etc.)

Comments

Contact 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..*
This element is affected by the following invariants: ele-1

Type ContactPoint(FR Core Contact Point Profile)

Is Modifier false

Requirements

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

246. Patient.contact.address

Definition

Address for the contact person.

Short Address for the contact person

Control 0..1

Address

Is Modifier false

Summary false

Requirements

Need to keep track where the contact person can be contacted per postal mail or visited.

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

248. Patient.contact.gender

Definition

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

Short male | female | other | unknown

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 false

Requirements

Needed to address the person correctly.

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

250. Patient.contact.organization

Definition

Organization on behalf of which the contact is acting or for which the contact is working.

Short Organization that is associated with the contact

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

Type Reference(Organization)

Is Modifier false

Summary false

Requirements

For guardians or business related contacts, the organization is relevant.

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

252. Patient.contact.period

Definition

The period during which this contact person or organization is valid to be contacted relating to this patient.

Short The period during which this contact person or organization is valid to be contacted relating to this patient

Control 0..1

Is Modifier false

Summary false

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

254. Patient.communication

Definition

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

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

Comments

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

Control 0..*

BackboneElement

Is Modifier false

Summary false

Requirements

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

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

256. Patient.communication.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

258. Patient.communication.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

260. Patient.communication.modifierExtension

Definition

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

262. Patient.communication.language

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-EN" for England English.

Short The language which can be used to communicate with the patient about his or her health

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.

Control 1..1

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

A human language.

Additional Bindings

Purpose

Is Modifier false

Summary false

Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

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

264. Patient.communication.preferred

Definition

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

Short Language preference indicator

Comments

This language is specifically identified for communicating healthcare information.

Control 0..1

boolean

Is Modifier false

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

Summary false

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.

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

266. Patient.generalPractitioner

Definition

Patient's nominated care provider.

Short Patient's nominated primary care provider

Comments

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

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

Control 0..*

Type Reference(FR Core Practitioner Profile, FR Core Organization Profile, PractitionerRole)

Is Modifier false

Summary false

Alternate Names careProvider

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

268. Patient.managingOrganization

Definition

Organization that is the custodian of the patient record.

Short Organization that is the custodian of the patient record

Comments

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

Control 0..1

Type Reference(FR Core Organization Profile)

Is Modifier false

Summary true

Requirements

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

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

270. Patient.link

Definition

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

Short Link to another patient resource that concerns the same actual person

Comments

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

Control 0..*

BackboneElement

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

Summary true

Requirements

There are multiple use cases:

Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
Distribution of patient information across multiple servers.

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

272. Patient.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

274. Patient.link.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

276. Patient.link.modifierExtension

Definition

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

278. Patient.link.other

Definition

The other patient resource that the link refers to.

Short The other patient or related person resource that the link refers to

Comments

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

Control 1..1

Type Reference(Patient, RelatedPerson)

Is Modifier false

Summary true

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

280. Patient.link.type

Definition

The type of link between this patient resource and another patient resource.

Short replaced-by | replaces | refer | seealso

Control 1..1

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

The type of link between this patient resource and another patient resource.