0.1.0 - ci-build
SENAITEFHIRImplementationGuide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.senaite.org/StructureDefinition/SenaitePatient | Version: 0.1.0 | |||
| Draft as of 2026-11-05 | Computable Name: SenaitePatient | |||
Demographic details of the patient
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: ![]() |
|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |
![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |
![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |
![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (required): The domestic partnership status of a person. | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:senaiteId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Patient.identifier:mrn.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍5.0.0 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍5.0.0 | FHIR Std. |
| Patient.maritalStatus | Base | required | Marital Status Codes | 📦5.0.0 | FHIR Std. |
| Patient.communication.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Patient.link.type | Base | required | Link Type | 📍5.0.0 | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |
![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |
![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | code | usual Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id | |
![]() ![]() ![]() ![]() |
1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | code | secondary Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn | |
![]() ![]() ![]() ![]() |
1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() |
0..0 | Text representation of the full name | ||
![]() ![]() ![]() |
0..0 | Time period when name was/is in use | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Time period when the contact point was/is in use | ||
![]() ![]() |
1..1 | code | male | female | other | unknown | |
![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (required): The domestic partnership status of a person. | |
![]() ![]() |
0..0 | Whether patient is part of a multiple birth | ||
![]() ![]() |
0..0 | Image of the patient | ||
![]() ![]() |
0..0 | A contact party (e.g. guardian, partner, friend) for the patient | ||
![]() ![]() |
0..0 | A language which may be used to communicate with the patient about his or her health | ||
![]() ![]() |
0..0 | Patient's nominated primary care provider | ||
![]() ![]() |
0..0 | Organization that is the custodian of the patient record | ||
![]() ![]() |
0..0 | Link to a Patient or RelatedPerson resource that concerns the same actual individual | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.maritalStatus | Base | required | Marital Status Codes | 📦5.0.0 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
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: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |||||
![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |||||
![]() ![]() |
1..* | HumanName | A name associated with the patient | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||
![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() |
0..* | ContactPoint | A contact detail for the individual | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
C | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() |
1..1 | date | The date of birth for the individual | |||||
![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |||||
![]() ![]() |
0..* | Address | An address for the individual | |||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (required): The domestic partnership status of a person. | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Patient.identifier:senaiteId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Patient.identifier:mrn.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Patient.identifier:mrn.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍5.0.0 | FHIR Std. |
| Patient.telecom.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Patient.telecom.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍5.0.0 | FHIR Std. |
| Patient.maritalStatus | Base | required | Marital Status Codes | 📦5.0.0 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍5.0.0 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍5.0.0 | FHIR Std. |
| Patient.communication.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Patient.link.type | Base | required | Link Type | 📍5.0.0 | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
This structure is derived from Patient
Summary
Mandatory: 3 elements(6 nested mandatory elements)
Fixed: 2 elements
Prohibited: 17 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |
![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |
![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |
![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (required): The domestic partnership status of a person. | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:senaiteId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Patient.identifier:mrn.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍5.0.0 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍5.0.0 | FHIR Std. |
| Patient.maritalStatus | Base | required | Marital Status Codes | 📦5.0.0 | FHIR Std. |
| Patient.communication.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Patient.link.type | Base | required | Link Type | 📍5.0.0 | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |
![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |
![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | code | usual Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id | |
![]() ![]() ![]() ![]() |
1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | code | secondary Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | uri | External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn | |
![]() ![]() ![]() ![]() |
1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() |
0..0 | Text representation of the full name | ||
![]() ![]() ![]() |
0..0 | Time period when name was/is in use | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Time period when the contact point was/is in use | ||
![]() ![]() |
1..1 | code | male | female | other | unknown | |
![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (required): The domestic partnership status of a person. | |
![]() ![]() |
0..0 | Whether patient is part of a multiple birth | ||
![]() ![]() |
0..0 | Image of the patient | ||
![]() ![]() |
0..0 | A contact party (e.g. guardian, partner, friend) for the patient | ||
![]() ![]() |
0..0 | A language which may be used to communicate with the patient about his or her health | ||
![]() ![]() |
0..0 | Patient's nominated primary care provider | ||
![]() ![]() |
0..0 | Organization that is the custodian of the patient record | ||
![]() ![]() |
0..0 | Link to a Patient or RelatedPerson resource that concerns the same actual individual | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.maritalStatus | Base | required | Marital Status Codes | 📦5.0.0 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
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: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | boolean | If the date of birth was not known precisely URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:use | |||||
![]() ![]() ![]() |
0..1 | Identifier | Internal SENAITE Patient ID — server-assigned, do not include on create | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | code | usual Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Internal SENAITE patient identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() |
0..1 | Identifier | External Patient ID from the consumer's system — may be supplied on create | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | code | secondary Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | External patient identifier, typically an MRN — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |||||
![]() ![]() |
1..* | HumanName | A name associated with the patient | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||
![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() |
0..* | ContactPoint | A contact detail for the individual | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
C | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() |
1..1 | date | The date of birth for the individual | |||||
![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |||||
![]() ![]() |
0..* | Address | An address for the individual | |||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (required): The domestic partnership status of a person. | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Patient.identifier:senaiteId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Patient.identifier:mrn.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Patient.identifier:mrn.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍5.0.0 | FHIR Std. |
| Patient.telecom.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Patient.telecom.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍5.0.0 | FHIR Std. |
| Patient.maritalStatus | Base | required | Marital Status Codes | 📦5.0.0 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍5.0.0 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍5.0.0 | FHIR Std. |
| Patient.communication.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Patient.link.type | Base | required | Link Type | 📍5.0.0 | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
This structure is derived from Patient
Summary
Mandatory: 3 elements(6 nested mandatory elements)
Fixed: 2 elements
Prohibited: 17 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron