Documentation des guides d'implémentation de l'ANS
0.1.0 - ci-build

This page is part of the Documentation des guides d'implémentation de l'ANS (v0.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 0.1.8. For a full list of available versions, see the Directory of published versions

Resource Profile: Patient français

Official URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/fr-patient Version: 0.1.0
Active as of 2023-05-05 Computable Name: FrPatient

Description du patient français

Usage:

Formal Views of Profile Content

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

This structure is derived from Patient

Summary

Mandatory: 3 elements
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of pattern:system

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... eyecolor S0..1CodeableConceptEye color of the patient
URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/EyeColor
Binding: EyeColor Value Set (required)
... Slices for identifier 1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:system
.... identifier:INS S1..1IdentifierAn identifier for this patient
..... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
... gender 0..1codemale | female | other
Binding: ModifiedAdministrativeGender (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta ΣN0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text N0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... eyecolor S0..1CodeableConceptEye color of the patient
URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/EyeColor
Binding: EyeColor Value Set (required)
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier Σ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:system
.... identifier:INS SΣ1..1IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN0..1CodeableConceptDescription 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.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period ΣCN0..1PeriodTime period when id is/was valid for use
..... assigner ΣCN0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name ΣN0..*HumanNameA name associated with the patient
... telecom ΣCN0..*ContactPointA contact detail for the individual
... gender Σ0..1codemale | female | other
Binding: ModifiedAdministrativeGender (required)
... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address ΣN0..*AddressAn address for the individual
... maritalStatus N0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo CN0..*AttachmentImage of the patient
... contact CN0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship N0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name N0..1HumanNameA name associated with the contact person
.... telecom CN0..*ContactPointA contact detail for the person
.... address N0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization CN0..1Reference(Organization)Organization that is associated with the contact
.... period CN0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication N0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language N1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner CN0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣCN0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣN0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣCN1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 3 elements
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of pattern:system

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... eyecolor S0..1CodeableConceptEye color of the patient
URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/EyeColor
Binding: EyeColor Value Set (required)
... Slices for identifier 1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:system
.... identifier:INS S1..1IdentifierAn identifier for this patient
..... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
... gender 0..1codemale | female | other
Binding: ModifiedAdministrativeGender (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta ΣN0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text N0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... eyecolor S0..1CodeableConceptEye color of the patient
URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/EyeColor
Binding: EyeColor Value Set (required)
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier Σ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:system
.... identifier:INS SΣ1..1IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN0..1CodeableConceptDescription 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.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.250.1.213.1.4.8
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period ΣCN0..1PeriodTime period when id is/was valid for use
..... assigner ΣCN0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name ΣN0..*HumanNameA name associated with the patient
... telecom ΣCN0..*ContactPointA contact detail for the individual
... gender Σ0..1codemale | female | other
Binding: ModifiedAdministrativeGender (required)
... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address ΣN0..*AddressAn address for the individual
... maritalStatus N0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo CN0..*AttachmentImage of the patient
... contact CN0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship N0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name N0..1HumanNameA name associated with the contact person
.... telecom CN0..*ContactPointA contact detail for the person
.... address N0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization CN0..1Reference(Organization)Organization that is associated with the contact
.... period CN0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication N0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language N1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner CN0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣCN0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣN0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣCN1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier:INS.userequiredIdentifierUse
Patient.identifier:INS.typeextensibleIdentifier Type Codes
Patient.genderrequiredModifiedAdministrativeGender
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
att-1errorPatient.photoIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
cpt-2errorPatient.telecom, Patient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.extension, Patient.extension:eyecolor, Patient.modifierExtension, Patient.identifier:INS.extension, Patient.contact.extension, Patient.contact.modifierExtension, Patient.communication.extension, Patient.communication.modifierExtension, Patient.link.extension, Patient.link.modifierExtensionMust 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()
per-1errorPatient.identifier:INS.period, Patient.contact.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorPatient.identifier:INS.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))