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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Eye color of the patient URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/EyeColor Binding: EyeColor Value Set (required) |
![]() ![]() ![]() | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system | |
![]() ![]() ![]() ![]() | S | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.250.1.213.1.4.8 | |
![]() ![]() ![]() | 0..1 | code | male | female | other Binding: ModifiedAdministrativeGender (required) | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | ΣN | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Eye color of the patient URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/EyeColor Binding: EyeColor Value Set (required) | ||||
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() | ΣN | 0..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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.250.1.213.1.4.8 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | ΣCN | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | ΣCN | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | ΣN | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() | ΣCN | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() | Σ | 0..1 | code | male | female | other Binding: ModifiedAdministrativeGender (required) | ||||
![]() ![]() ![]() | Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | ΣN | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() | N | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | CN | 0..* | Attachment | Image of the patient | ||||
![]() ![]() ![]() | CN | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | N | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | ||||
![]() ![]() ![]() ![]() | N | 0..1 | HumanName | A name associated with the contact person | ||||
![]() ![]() ![]() ![]() | CN | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() | N | 0..1 | Address | Address for the contact person | ||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | CN | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | CN | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||
![]() ![]() ![]() | N | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | N | 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.
| ||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | CN | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||
![]() ![]() ![]() | ΣCN | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!ΣN | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | ΣCN | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Eye color of the patient URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/EyeColor Binding: EyeColor Value Set (required) | |
![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient |
![]() |
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:
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Eye color of the patient URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/EyeColor Binding: EyeColor Value Set (required) |
![]() ![]() ![]() | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system | |
![]() ![]() ![]() ![]() | S | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.250.1.213.1.4.8 | |
![]() ![]() ![]() | 0..1 | code | male | female | other Binding: ModifiedAdministrativeGender (required) | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | ΣN | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Eye color of the patient URL: https://interop.esante.gouv.fr/ig/documentation/StructureDefinition/EyeColor Binding: EyeColor Value Set (required) | ||||
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() | ΣN | 0..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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.250.1.213.1.4.8 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | ΣCN | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | ΣCN | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | ΣN | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() | ΣCN | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() | Σ | 0..1 | code | male | female | other Binding: ModifiedAdministrativeGender (required) | ||||
![]() ![]() ![]() | Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | ΣN | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() | N | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | CN | 0..* | Attachment | Image of the patient | ||||
![]() ![]() ![]() | CN | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | N | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | ||||
![]() ![]() ![]() ![]() | N | 0..1 | HumanName | A name associated with the contact person | ||||
![]() ![]() ![]() ![]() | CN | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() | N | 0..1 | Address | Address for the contact person | ||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | CN | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | CN | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||
![]() ![]() ![]() | N | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | N | 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.
| ||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | CN | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||
![]() ![]() ![]() | ΣCN | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!ΣN | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | ΣCN | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.identifier:INS.use | required | IdentifierUse | ||||
Patient.identifier:INS.type | extensible | Identifier Type Codes | ||||
Patient.gender | required | ModifiedAdministrativeGender | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | Patient.photo | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
cpt-2 | error | Patient.telecom, Patient.contact.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Patient.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.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
per-1 | error | Patient.identifier:INS.period, Patient.contact.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
ref-1 | error | Patient.identifier:INS.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other | SHALL 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')) |