Guide d'implémentation Fr Core
2.1.0 - trial-use France flag

This page is part of the Guide d'implémentation Fr Core (v2.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: FR Core Patient Profile

Official URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient Version: 2.1.0
Active as of 2024-09-04 Computable Name: FRCorePatientProfile

Profile of the Patient resource for France. This profile specifies the patient’s identifiers for France. It uses international extensions (birtplace and nationality) and adds specific French extensions.

Ce profil spécifie les identifiants de patient utilisés en France. Il utilise des extensions internationales (birthplace et nationalité) et ajoute des extensions propres à la France.)

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... meta
.... Slices for profile 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fr-canonical 0..1 canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient
... Slices for extension Content/Rules for all slices
.... nationality 0..1 (Complex) Nationality
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-nationality
.... identityReliability 0..* (Complex) Reliabilility of the identity | Fiabilité de l'identité
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-identity-reliability
.... deathPlace 0..1 string FR Core Patient Death Place Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-death-place
.... birthdateUpdateIndicator 0..1 boolean FR Core Patient Birthdate Update Indicator Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birthdate-update-indicator
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... value[x] 1..1 FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for identifier 0..* Identifier 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.
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... type 0..1 CodeableConcept Description of identifier
Binding: FR Core ValueSet Patient identifier type (extensible)
.... identifier:NSS 0..1 Identifier 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é).
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
..... system 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
..... value 1..1 string The value that is unique
.... identifier:INS-C 0..* Identifier Computed National Health Identifier | Identifiant National de Santé Calculé à partir des éléments de la carte vitale
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INS-C
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant National de Santé Calculé
..... system 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.2
..... value 1..1 string The value that is unique
.... identifier:NDP 0..1 Identifier French pharmaceutical Record Identifier | Numéro de Dossier Pharmaceutique français. Celui-ci est unique.
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NDP
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant du patient au Dossier Pharmaceutique
..... system 1..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.176.1.2
..... value 1..1 string The value that is unique
.... identifier:PI 0..* Identifier Hospital assigned patient identifier | IPP
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Patient internal identifier
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:RRI 0..* Identifier Regional Registry ID | Identifiant régional
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RRI
....... display 1..1 string Representation defined by the system
Fixed Value: Regional registry ID
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... name:usualName 0..* HumanName Name of a human | Nom utilisé
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Required Pattern: usual
.... name:officialName 0..* HumanName Name of a human | Nom de naissance
..... Slices for extension Content/Rules for all slices
...... birth-list-given-name 0..1 string 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.
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birth-list-given-name
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Required Pattern: official
..... family 1..1 string Family name (often called 'Surname')
..... given 1..* string Given names (not always 'first'). Includes middle names
... telecom 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
... gender 0..1 code male | female | other | unknown
... birthDate 0..1 date 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.
... address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: FR Core ValueSet Patient gender INS ValueSet (extensible)
... contact
.... Slices for extension Content/Rules for all slices
..... contactIdentifier 0..1 Identifier Contact identifier in the patient resource | Identifiant de contact dans la ressource Patient
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-contact-identifier
..... comment 0..1 string Comment on a dataElement | Commentaire sur un dataElement
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-comment
.... Slices for relationship 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:coding.system
..... relationship:Role 0..1 CodeableConcept The nature of the relationship. Rôle de la personne. Ex : personne de confiance, aidant ...
Binding: FR Core ValueSet Patient contact role (extensible)
..... relationship:RelationType 0..1 CodeableConcept The nature of the relationship. Relation de la personne. Ex : Mère, époux, enfant ...
Binding: FR Core ValueSet relation type (extensible)
.... name 0..1 FRCoreHumanNameProfile Name of a human - parts and usage
.... telecom 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
... generalPractitioner 0..* Reference(FR Core Practitioner Profile | FR Core Organization Profile | PractitionerRole) Patient's nominated primary care provider
... managingOrganization 0..1 Reference(FR Core Organization Profile) Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.identifier.typeextensibleFRCoreValueSetPatientIdentifierType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-identifier-type
from this IG
Patient.maritalStatusextensibleFRCoreValueSetMaritalStatus
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-marital-status
from this IG
Patient.contact.relationship:RoleextensibleFRCoreValueSetPatientContactRole
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-contact-role
from this IG
Patient.contact.relationship:RelationTypeextensibleFRCoreValueSetPatientRelationType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-relation-type
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... nationality 0..1 (Complex) Nationality
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-nationality
.... identityReliability 0..* (Complex) Reliabilility of the identity | Fiabilité de l'identité
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-identity-reliability
.... deathPlace 0..1 string FR Core Patient Death Place Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-death-place
.... birthdateUpdateIndicator 0..1 boolean FR Core Patient Birthdate Update Indicator Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birthdate-update-indicator
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: FR Core ValueSet Patient identifier type (extensible)
.... identifier:NSS Σ 0..1 Identifier 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é).
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:INS-C Σ 0..* Identifier Computed National Health Identifier | Identifiant National de Santé Calculé à partir des éléments de la carte vitale
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INS-C
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant National de Santé Calculé
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.2
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:NDP Σ 0..1 Identifier French pharmaceutical Record Identifier | Numéro de Dossier Pharmaceutique français. Celui-ci est unique.
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NDP
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant du patient au Dossier Pharmaceutique
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.176.1.2
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:PI Σ 0..* Identifier Hospital assigned patient identifier | IPP
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Patient internal identifier
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:RRI Σ 0..* Identifier Regional Registry ID | Identifiant régional
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RRI
....... display 1..1 string Representation defined by the system
Fixed Value: Regional registry ID
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name Σ 0..* FRCoreHumanNameProfile A name associated with the patient
Slice: Unordered, Open by value:use
.... name:usualName Σ 0..* HumanName Name of a human | Nom utilisé
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: usual
.... name:officialName Σ 0..* HumanName Name of a human | Nom de naissance
..... Slices for extension Content/Rules for all slices
...... birth-list-given-name 0..1 string 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.
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birth-list-given-name
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom C 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date 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.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: FR Core ValueSet Patient gender INS ValueSet (extensible)
... generalPractitioner 0..* Reference(FR Core Practitioner Profile | FR Core Organization Profile | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(FR Core Organization Profile) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleFRCoreValueSetPatientIdentifierType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-identifier-type
from this IG
Patient.identifier:NSS.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NSS.typeextensiblePattern: NH
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:INS-C.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:INS-C.typeextensiblePattern: INS-C("Identifiant National de Santé Calculé")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:NDP.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NDP.typeextensiblePattern: NDP("Identifiant du patient au Dossier Pharmaceutique")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:PI.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:PI.typeextensiblePattern: PI("Patient internal identifier")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:RRI.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:RRI.typeextensiblePattern: RRI("Regional registry ID")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name:usualName.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:officialName.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleFRCoreValueSetMaritalStatus
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-marital-status
from this IG
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fr-canonical Σ 0..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... nationality 0..1 (Complex) Nationality
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-nationality
.... identityReliability 0..* (Complex) Reliabilility of the identity | Fiabilité de l'identité
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-identity-reliability
.... deathPlace 0..1 string FR Core Patient Death Place Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-death-place
.... birthdateUpdateIndicator 0..1 boolean FR Core Patient Birthdate Update Indicator Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birthdate-update-indicator
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier 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.
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: FR Core ValueSet Patient identifier type (extensible)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:NSS Σ 0..1 Identifier 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é).
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:INS-C Σ 0..* Identifier Computed National Health Identifier | Identifiant National de Santé Calculé à partir des éléments de la carte vitale
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INS-C
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant National de Santé Calculé
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.2
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:NDP Σ 0..1 Identifier French pharmaceutical Record Identifier | Numéro de Dossier Pharmaceutique français. Celui-ci est unique.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NDP
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant du patient au Dossier Pharmaceutique
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.176.1.2
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PI Σ 0..* Identifier Hospital assigned patient identifier | IPP
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Patient internal identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:RRI Σ 0..* Identifier Regional Registry ID | Identifiant régional
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RRI
....... display 1..1 string Representation defined by the system
Fixed Value: Regional registry ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name Σ 0..* FRCoreHumanNameProfile A name associated with the patient
Slice: Unordered, Open by value:use
.... name:usualName Σ 0..* HumanName Name of a human | Nom utilisé
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:officialName Σ 0..* HumanName Name of a human | Nom de naissance
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... birth-list-given-name 0..1 string 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.
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birth-list-given-name
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
..... text Σ 0..1 string Text representation of the full name
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom C 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date 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.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: FR Core ValueSet Patient gender INS ValueSet (extensible)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... contactIdentifier 0..1 Identifier Contact identifier in the patient resource | Identifiant de contact dans la ressource Patient
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-contact-identifier
..... comment 0..1 string Comment on a dataElement | Commentaire sur un dataElement
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-comment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for relationship 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:coding.system
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... relationship:Role 0..1 CodeableConcept The nature of the relationship. Rôle de la personne. Ex : personne de confiance, aidant ...
Binding: FR Core ValueSet Patient contact role (extensible)
..... relationship:RelationType 0..1 CodeableConcept The nature of the relationship. Relation de la personne. Ex : Mère, époux, enfant ...
Binding: FR Core ValueSet relation type (extensible)
.... name 0..1 FRCoreHumanNameProfile Name of a human - parts and usage
.... telecom C 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(FR Core Practitioner Profile | FR Core Organization Profile | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(FR Core Organization Profile) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Patient.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleFRCoreValueSetPatientIdentifierType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-identifier-type
from this IG
Patient.identifier:NSS.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NSS.typeextensiblePattern: NH
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:INS-C.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:INS-C.typeextensiblePattern: INS-C("Identifiant National de Santé Calculé")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:NDP.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NDP.typeextensiblePattern: NDP("Identifiant du patient au Dossier Pharmaceutique")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:PI.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:PI.typeextensiblePattern: PI("Patient internal identifier")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:RRI.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:RRI.typeextensiblePattern: RRI("Regional registry ID")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name:usualName.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:officialName.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleFRCoreValueSetMaritalStatus
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-marital-status
from this IG
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.relationship:RoleextensibleFRCoreValueSetPatientContactRole
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-contact-role
from this IG
Patient.contact.relationship:RelationTypeextensibleFRCoreValueSetPatientRelationType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-relation-type
from this IG
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecom, Patient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 0 element(17 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.meta.profile
  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.name
  • The element 1 is sliced based on the value of Patient.contact.relationship

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... meta
.... Slices for profile 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fr-canonical 0..1 canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient
... Slices for extension Content/Rules for all slices
.... nationality 0..1 (Complex) Nationality
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-nationality
.... identityReliability 0..* (Complex) Reliabilility of the identity | Fiabilité de l'identité
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-identity-reliability
.... deathPlace 0..1 string FR Core Patient Death Place Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-death-place
.... birthdateUpdateIndicator 0..1 boolean FR Core Patient Birthdate Update Indicator Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birthdate-update-indicator
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... value[x] 1..1 FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for identifier 0..* Identifier 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.
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... type 0..1 CodeableConcept Description of identifier
Binding: FR Core ValueSet Patient identifier type (extensible)
.... identifier:NSS 0..1 Identifier 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é).
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
..... system 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
..... value 1..1 string The value that is unique
.... identifier:INS-C 0..* Identifier Computed National Health Identifier | Identifiant National de Santé Calculé à partir des éléments de la carte vitale
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INS-C
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant National de Santé Calculé
..... system 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.2
..... value 1..1 string The value that is unique
.... identifier:NDP 0..1 Identifier French pharmaceutical Record Identifier | Numéro de Dossier Pharmaceutique français. Celui-ci est unique.
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NDP
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant du patient au Dossier Pharmaceutique
..... system 1..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.176.1.2
..... value 1..1 string The value that is unique
.... identifier:PI 0..* Identifier Hospital assigned patient identifier | IPP
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Patient internal identifier
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:RRI 0..* Identifier Regional Registry ID | Identifiant régional
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RRI
....... display 1..1 string Representation defined by the system
Fixed Value: Regional registry ID
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... name:usualName 0..* HumanName Name of a human | Nom utilisé
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Required Pattern: usual
.... name:officialName 0..* HumanName Name of a human | Nom de naissance
..... Slices for extension Content/Rules for all slices
...... birth-list-given-name 0..1 string 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.
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birth-list-given-name
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Required Pattern: official
..... family 1..1 string Family name (often called 'Surname')
..... given 1..* string Given names (not always 'first'). Includes middle names
... telecom 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
... gender 0..1 code male | female | other | unknown
... birthDate 0..1 date 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.
... address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: FR Core ValueSet Patient gender INS ValueSet (extensible)
... contact
.... Slices for extension Content/Rules for all slices
..... contactIdentifier 0..1 Identifier Contact identifier in the patient resource | Identifiant de contact dans la ressource Patient
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-contact-identifier
..... comment 0..1 string Comment on a dataElement | Commentaire sur un dataElement
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-comment
.... Slices for relationship 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:coding.system
..... relationship:Role 0..1 CodeableConcept The nature of the relationship. Rôle de la personne. Ex : personne de confiance, aidant ...
Binding: FR Core ValueSet Patient contact role (extensible)
..... relationship:RelationType 0..1 CodeableConcept The nature of the relationship. Relation de la personne. Ex : Mère, époux, enfant ...
Binding: FR Core ValueSet relation type (extensible)
.... name 0..1 FRCoreHumanNameProfile Name of a human - parts and usage
.... telecom 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
... generalPractitioner 0..* Reference(FR Core Practitioner Profile | FR Core Organization Profile | PractitionerRole) Patient's nominated primary care provider
... managingOrganization 0..1 Reference(FR Core Organization Profile) Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.identifier.typeextensibleFRCoreValueSetPatientIdentifierType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-identifier-type
from this IG
Patient.maritalStatusextensibleFRCoreValueSetMaritalStatus
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-marital-status
from this IG
Patient.contact.relationship:RoleextensibleFRCoreValueSetPatientContactRole
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-contact-role
from this IG
Patient.contact.relationship:RelationTypeextensibleFRCoreValueSetPatientRelationType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-relation-type
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... nationality 0..1 (Complex) Nationality
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-nationality
.... identityReliability 0..* (Complex) Reliabilility of the identity | Fiabilité de l'identité
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-identity-reliability
.... deathPlace 0..1 string FR Core Patient Death Place Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-death-place
.... birthdateUpdateIndicator 0..1 boolean FR Core Patient Birthdate Update Indicator Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birthdate-update-indicator
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: FR Core ValueSet Patient identifier type (extensible)
.... identifier:NSS Σ 0..1 Identifier 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é).
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:INS-C Σ 0..* Identifier Computed National Health Identifier | Identifiant National de Santé Calculé à partir des éléments de la carte vitale
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INS-C
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant National de Santé Calculé
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.2
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:NDP Σ 0..1 Identifier French pharmaceutical Record Identifier | Numéro de Dossier Pharmaceutique français. Celui-ci est unique.
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NDP
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant du patient au Dossier Pharmaceutique
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.176.1.2
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:PI Σ 0..* Identifier Hospital assigned patient identifier | IPP
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Patient internal identifier
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:RRI Σ 0..* Identifier Regional Registry ID | Identifiant régional
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RRI
....... display 1..1 string Representation defined by the system
Fixed Value: Regional registry ID
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name Σ 0..* FRCoreHumanNameProfile A name associated with the patient
Slice: Unordered, Open by value:use
.... name:usualName Σ 0..* HumanName Name of a human | Nom utilisé
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: usual
.... name:officialName Σ 0..* HumanName Name of a human | Nom de naissance
..... Slices for extension Content/Rules for all slices
...... birth-list-given-name 0..1 string 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.
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birth-list-given-name
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom C 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date 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.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: FR Core ValueSet Patient gender INS ValueSet (extensible)
... generalPractitioner 0..* Reference(FR Core Practitioner Profile | FR Core Organization Profile | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(FR Core Organization Profile) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleFRCoreValueSetPatientIdentifierType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-identifier-type
from this IG
Patient.identifier:NSS.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NSS.typeextensiblePattern: NH
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:INS-C.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:INS-C.typeextensiblePattern: INS-C("Identifiant National de Santé Calculé")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:NDP.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NDP.typeextensiblePattern: NDP("Identifiant du patient au Dossier Pharmaceutique")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:PI.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:PI.typeextensiblePattern: PI("Patient internal identifier")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:RRI.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:RRI.typeextensiblePattern: RRI("Regional registry ID")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name:usualName.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:officialName.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleFRCoreValueSetMaritalStatus
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-marital-status
from this IG
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
..... profile:fr-canonical Σ 0..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... nationality 0..1 (Complex) Nationality
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-nationality
.... identityReliability 0..* (Complex) Reliabilility of the identity | Fiabilité de l'identité
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-identity-reliability
.... deathPlace 0..1 string FR Core Patient Death Place Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-death-place
.... birthdateUpdateIndicator 0..1 boolean FR Core Patient Birthdate Update Indicator Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birthdate-update-indicator
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier 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.
Slice: Unordered, Open by value:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: FR Core ValueSet Patient identifier type (extensible)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:NSS Σ 0..1 Identifier 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é).
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NH
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:INS-C Σ 0..* Identifier Computed National Health Identifier | Identifiant National de Santé Calculé à partir des éléments de la carte vitale
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INS-C
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant National de Santé Calculé
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.2
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:NDP Σ 0..1 Identifier French pharmaceutical Record Identifier | Numéro de Dossier Pharmaceutique français. Celui-ci est unique.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NDP
....... display 1..1 string Representation defined by the system
Fixed Value: Identifiant du patient au Dossier Pharmaceutique
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.176.1.2
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PI Σ 0..* Identifier Hospital assigned patient identifier | IPP
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Patient internal identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:RRI Σ 0..* Identifier Regional Registry ID | Identifiant régional
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RRI
....... display 1..1 string Representation defined by the system
Fixed Value: Regional registry ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name Σ 0..* FRCoreHumanNameProfile A name associated with the patient
Slice: Unordered, Open by value:use
.... name:usualName Σ 0..* HumanName Name of a human | Nom utilisé
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:officialName Σ 0..* HumanName Name of a human | Nom de naissance
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... birth-list-given-name 0..1 string 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.
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-birth-list-given-name
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
..... text Σ 0..1 string Text representation of the full name
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom C 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date 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.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: FR Core ValueSet Patient gender INS ValueSet (extensible)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... contactIdentifier 0..1 Identifier Contact identifier in the patient resource | Identifiant de contact dans la ressource Patient
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-patient-contact-identifier
..... comment 0..1 string Comment on a dataElement | Commentaire sur un dataElement
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-comment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for relationship 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:coding.system
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... relationship:Role 0..1 CodeableConcept The nature of the relationship. Rôle de la personne. Ex : personne de confiance, aidant ...
Binding: FR Core ValueSet Patient contact role (extensible)
..... relationship:RelationType 0..1 CodeableConcept The nature of the relationship. Relation de la personne. Ex : Mère, époux, enfant ...
Binding: FR Core ValueSet relation type (extensible)
.... name 0..1 FRCoreHumanNameProfile Name of a human - parts and usage
.... telecom C 0..* FRCoreContactPointProfile Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(FR Core Practitioner Profile | FR Core Organization Profile | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(FR Core Organization Profile) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Patient.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleFRCoreValueSetPatientIdentifierType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-identifier-type
from this IG
Patient.identifier:NSS.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NSS.typeextensiblePattern: NH
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:INS-C.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:INS-C.typeextensiblePattern: INS-C("Identifiant National de Santé Calculé")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:NDP.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NDP.typeextensiblePattern: NDP("Identifiant du patient au Dossier Pharmaceutique")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:PI.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:PI.typeextensiblePattern: PI("Patient internal identifier")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:RRI.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:RRI.typeextensiblePattern: RRI("Regional registry ID")
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name:usualName.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:officialName.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleFRCoreValueSetMaritalStatus
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-marital-status
from this IG
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.relationship:RoleextensibleFRCoreValueSetPatientContactRole
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-patient-contact-role
from this IG
Patient.contact.relationship:RelationTypeextensibleFRCoreValueSetPatientRelationType
https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-relation-type
from this IG
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecom, Patient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 0 element(17 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.meta.profile
  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.name
  • The element 1 is sliced based on the value of Patient.contact.relationship

 

Other representations of profile: CSV, Excel, Schematron