PanCareSurPass Project HL7 FHIR Implementation Guide
1.0.0 - release
150
PanCareSurPass Project HL7 FHIR Implementation Guide
1.0.0 - release
150
PanCareSurPass Project HL7 FHIR Implementation Guide, published by PanCareSurPass Project. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/pcsp/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/Patient-eu-pcsp | Version: 1.0.0 | |||
| Active as of 2025-10-16 | Computable Name: PatientPcsp | |||
This profile defines how to represent Patient in FHIR for the purpose of the PanCareSurPass project.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Patient |
0..* | PatientUvIps | Information about an individual 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 | |||||||||||||||
   extension:genderIdentity |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]] | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1 | |||||||||||||
| extension:personalPronouns |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]] | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1 | |||||||||||||
| extension:patient-birthPlace |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||||||||
 extension:patient-mothersMaidenName |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
 identifier |
SOΣ | 1..* | Identifier | An identifier for this patient
| ||||||||||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||||||||
| name |
SOΣC | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
| ||||||||||||
| use |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||||||||
| text |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||
 given |
SOΣ | 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 |
SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||||||||
| gender |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||||||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
 extension:originalText |
0..1 | string, url | Original Text that represents the data as seen/selected/uttered originally URL: http://hl7.org/fhir/StructureDefinition/originalText | |||||||||||||
| birthDate |
SOΣ | 1..1 | date | The date of birth for the individual
| ||||||||||||
 deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||||||||||
| deceasedBoolean |
boolean | |||||||||||||||
| deceasedDateTime |
dateTime | |||||||||||||||
| address |
SOΣ | 0..* | Address | An address for the individual
| ||||||||||||
| contact |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| telecom |
S | 1..* | ContactPoint | A contact detail for the person | ||||||||||||
| Slices for generalPractitioner |
SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by type:resolve()
| ||||||||||||
 generalPractitioner:primaryTreatmentCenter |
SO | 0..1 | Reference(Organization: Primary Treatment Center / Center of diagnosis | Organization) | Primary treatment center
| ||||||||||||
 identifier |
Σ | 0..1 | Identifier | Business identifier of the Primary treatment center | ||||||||||||
 display |
Σ | 0..1 | string | Short textual description of the Primary treatment center | ||||||||||||
| 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. | ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If 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-4 | error | Patient | If 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-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present |
family.exists() or given.exists() or text.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()
|
This structure is derived from PatientUvIps
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | PatientUvIps | Information about an individual receiving health care services | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:patient-birthPlace |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
| extension:patient-mothersMaidenName |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |
 identifier |
1..* | Identifier | An identifier for this patient | |
| name |
||||
| family |
1..1 | string | Family name (often called 'Surname') | |
| given |
1..* | string | Given names (not always 'first'). Includes middle names | |
| gender |
1..1 | code | male | female | other | unknown | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:originalText |
0..1 | string, url | Original Text that represents the data as seen/selected/uttered originally URL: http://hl7.org/fhir/StructureDefinition/originalText | |
| contact |
||||
| telecom |
S | 1..* | ContactPoint | A contact detail for the person |
| Slices for generalPractitioner |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by type:resolve() | |
| generalPractitioner:primaryTreatmentCenter |
S | 0..1 | Reference(Organization: Primary Treatment Center / Center of diagnosis | Organization) | Primary treatment center |
| identifier |
0..1 | Identifier | Business identifier of the Primary treatment center | |
| display |
0..1 | string | Short textual description of the Primary treatment center | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | PatientUvIps | Information about an individual receiving health care services | |||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:genderIdentity |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]] | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1 | |||||||||||||
| extension:personalPronouns |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]] | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1 | |||||||||||||
| extension:patient-birthPlace |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||||||||
| extension:patient-mothersMaidenName |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
SOΣ | 1..* | Identifier | An identifier for this patient
| ||||||||||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||||||||
| name |
SOΣC | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
| ||||||||||||
| 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 |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||||||||
| text |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||
| given |
SOΣ | 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 |
SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||||||||
| gender |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:originalText |
0..1 | string, url | Original Text that represents the data as seen/selected/uttered originally URL: http://hl7.org/fhir/StructureDefinition/originalText | |||||||||||||
| value |
0..1 | string | Primitive value for code | |||||||||||||
| birthDate |
SOΣ | 1..1 | date | The date of birth for the individual
| ||||||||||||
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||||||||||
| deceasedBoolean |
boolean | |||||||||||||||
| deceasedDateTime |
dateTime | |||||||||||||||
| address |
SOΣ | 0..* | Address | An address for the individual
| ||||||||||||
| maritalStatus |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||||||||
| 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 Constraints: pat-1 | ||||||||||||
| 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 | ||||||||||||
| relationship |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||||||||
| name |
0..1 | HumanName | A name associated with the contact person | |||||||||||||
| telecom |
S | 1..* | ContactPoint | A contact detail for the person | ||||||||||||
| 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.
| |||||||||||||
| preferred |
0..1 | boolean | Language preference indicator | |||||||||||||
| Slices for generalPractitioner |
SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by type:resolve()
| ||||||||||||
| generalPractitioner:primaryTreatmentCenter |
SO | 0..1 | Reference(Organization: Primary Treatment Center / Center of diagnosis | Organization) | Primary treatment center
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Business identifier of the Primary treatment center | ||||||||||||
| display |
Σ | 0..1 | string | Short textual description of the Primary treatment center | ||||||||||||
| managingOrganization |
Σ | 0..1 | Reference(Organization) | 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. | ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.generalPractitioner:primaryTreatmentCenter.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If 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-4 | error | Patient | If 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-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present |
family.exists() or given.exists() or text.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()
|
This structure is derived from PatientUvIps
Summary
Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | PatientUvIps | Information about an individual 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 | |||||||||||||||
| extension:genderIdentity |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]] | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1 | |||||||||||||
| extension:personalPronouns |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]] | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1 | |||||||||||||
| extension:patient-birthPlace |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||||||||
| extension:patient-mothersMaidenName |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
SOΣ | 1..* | Identifier | An identifier for this patient
| ||||||||||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||||||||
| name |
SOΣC | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
| ||||||||||||
| use |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||||||||
| text |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||
| given |
SOΣ | 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 |
SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||||||||
| gender |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:originalText |
0..1 | string, url | Original Text that represents the data as seen/selected/uttered originally URL: http://hl7.org/fhir/StructureDefinition/originalText | |||||||||||||
| birthDate |
SOΣ | 1..1 | date | The date of birth for the individual
| ||||||||||||
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||||||||||
| deceasedBoolean |
boolean | |||||||||||||||
| deceasedDateTime |
dateTime | |||||||||||||||
| address |
SOΣ | 0..* | Address | An address for the individual
| ||||||||||||
| contact |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| telecom |
S | 1..* | ContactPoint | A contact detail for the person | ||||||||||||
| Slices for generalPractitioner |
SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by type:resolve()
| ||||||||||||
| generalPractitioner:primaryTreatmentCenter |
SO | 0..1 | Reference(Organization: Primary Treatment Center / Center of diagnosis | Organization) | Primary treatment center
| ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Business identifier of the Primary treatment center | ||||||||||||
| display |
Σ | 0..1 | string | Short textual description of the Primary treatment center | ||||||||||||
| 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. | ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If 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-4 | error | Patient | If 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-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present |
family.exists() or given.exists() or text.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()
|
Differential View
This structure is derived from PatientUvIps
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | PatientUvIps | Information about an individual receiving health care services | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:patient-birthPlace |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
| extension:patient-mothersMaidenName |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |
| identifier |
1..* | Identifier | An identifier for this patient | |
| name |
||||
| family |
1..1 | string | Family name (often called 'Surname') | |
| given |
1..* | string | Given names (not always 'first'). Includes middle names | |
| gender |
1..1 | code | male | female | other | unknown | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:originalText |
0..1 | string, url | Original Text that represents the data as seen/selected/uttered originally URL: http://hl7.org/fhir/StructureDefinition/originalText | |
| contact |
||||
| telecom |
S | 1..* | ContactPoint | A contact detail for the person |
| Slices for generalPractitioner |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by type:resolve() | |
| generalPractitioner:primaryTreatmentCenter |
S | 0..1 | Reference(Organization: Primary Treatment Center / Center of diagnosis | Organization) | Primary treatment center |
| identifier |
0..1 | Identifier | Business identifier of the Primary treatment center | |
| display |
0..1 | string | Short textual description of the Primary treatment center | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | PatientUvIps | Information about an individual receiving health care services | |||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:genderIdentity |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]] | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1 | |||||||||||||
| extension:personalPronouns |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]] | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1 | |||||||||||||
| extension:patient-birthPlace |
0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||||||||
| extension:patient-mothersMaidenName |
0..1 | string | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
SOΣ | 1..* | Identifier | An identifier for this patient
| ||||||||||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||||||||
| name |
SOΣC | 1..* | HumanName | A name associated with the patient Constraints: ips-pat-1
| ||||||||||||
| 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 |
?!SOΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
| ||||||||||||
| text |
SOΣ | 0..1 | string | Text representation of the full name
| ||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||
| given |
SOΣ | 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 |
SOΣ | 0..* | ContactPoint | A contact detail for the individual
| ||||||||||||
| gender |
SOΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
| ||||||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:originalText |
0..1 | string, url | Original Text that represents the data as seen/selected/uttered originally URL: http://hl7.org/fhir/StructureDefinition/originalText | |||||||||||||
| value |
0..1 | string | Primitive value for code | |||||||||||||
| birthDate |
SOΣ | 1..1 | date | The date of birth for the individual
| ||||||||||||
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||||||||||
| deceasedBoolean |
boolean | |||||||||||||||
| deceasedDateTime |
dateTime | |||||||||||||||
| address |
SOΣ | 0..* | Address | An address for the individual
| ||||||||||||
| maritalStatus |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||||||||
| 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 Constraints: pat-1 | ||||||||||||
| 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 | ||||||||||||
| relationship |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||||||||
| name |
0..1 | HumanName | A name associated with the contact person | |||||||||||||
| telecom |
S | 1..* | ContactPoint | A contact detail for the person | ||||||||||||
| 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.
| |||||||||||||
| preferred |
0..1 | boolean | Language preference indicator | |||||||||||||
| Slices for generalPractitioner |
SO | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by type:resolve()
| ||||||||||||
| generalPractitioner:primaryTreatmentCenter |
SO | 0..1 | Reference(Organization: Primary Treatment Center / Center of diagnosis | Organization) | Primary treatment center
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Business identifier of the Primary treatment center | ||||||||||||
| display |
Σ | 0..1 | string | Short textual description of the Primary treatment center | ||||||||||||
| managingOrganization |
Σ | 0..1 | Reference(Organization) | 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. | ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.generalPractitioner:primaryTreatmentCenter.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If 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-4 | error | Patient | If 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-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ips-pat-1 | error | Patient.name | Patient.name.given, Patient.name.family or Patient.name.text SHALL be present |
family.exists() or given.exists() or text.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()
|
This structure is derived from PatientUvIps
Summary
Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ PanCareSurPass Project. Package hl7.eu.fhir.pcsp#1.0.0 based on FHIR 4.0.1. Generated 2025-10-16
Links: Table of Contents |
QA Report
The PanCareSurPass Research and Innovation Action has received funding from the European Union's Horizon 2020
research and innovation programme under grant agreement No. 899999.
