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

Resource Profile: SenaitePatient

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

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Patient.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Patient.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Patient.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Example General: 123456
Patient.Slices for identifier.identifier:mrn This element is included in summaries. 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Patient.Slices for identifier.identifier:mrn.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:mrn.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Patient.Slices for identifier.identifier:mrn.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:mrn.value This element is included in summaries. C 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 dateTime Indicates if the individual is deceased or not
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (required): The domestic partnership status of a person.

doco Documentation for this format

Terminology Bindings

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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Patient.Slices for identifier 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Patient.Slices for identifier.identifier:senaiteId 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Patient.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Patient.Slices for identifier.identifier:senaiteId.use 1..1 code usual
Fixed Value: usual (no extensions allowed)
Patient.Slices for identifier.identifier:senaiteId.type 0..0 Description of identifier
Patient.Slices for identifier.identifier:senaiteId.system 1..1 uri Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id
Patient.Slices for identifier.identifier:senaiteId.value 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Patient.Slices for identifier.identifier:senaiteId.period 0..0 Time period when id is/was valid for use
Patient.Slices for identifier.identifier:senaiteId.assigner 0..0 Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:mrn 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Patient.Slices for identifier.identifier:mrn.extension 0..0 Extension
Patient.Slices for identifier.identifier:mrn.use 1..1 code secondary
Fixed Value: secondary (no extensions allowed)
Patient.Slices for identifier.identifier:mrn.system 1..1 uri External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn
Patient.Slices for identifier.identifier:mrn.value 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Patient.Slices for identifier.identifier:mrn.period 0..0 Time period when id is/was valid for use
Patient.Slices for identifier.identifier:mrn.assigner 0..0 Organization that issued id (may be just text)
Patient.name 1..* HumanName A name associated with the patient
Patient.name.text 0..0 Text representation of the full name
Patient.name.period 0..0 Time period when name was/is in use
Patient.telecom.period 0..0 Time period when the contact point was/is in use
Patient.gender 1..1 code male | female | other | unknown
Patient.birthDate 1..1 date The date of birth for the individual
Patient.deceased[x] 0..1 dateTime Indicates if the individual is deceased or not
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (required): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..0 Whether patient is part of a multiple birth
Patient.photo 0..0 Image of the patient
Patient.contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
Patient.communication 0..0 A language which may be used to communicate with the patient about his or her health
Patient.generalPractitioner 0..0 Patient's nominated primary care provider
Patient.managingOrganization 0..0 Organization that is the custodian of the patient record
Patient.link 0..0 Link to a Patient or RelatedPerson resource that concerns the same actual individual

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.maritalStatus Base required Marital Status Codes 📦5.0.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Patient.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Patient.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Patient.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Example General: 123456
Patient.Slices for identifier.identifier:mrn This element is included in summaries. 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Patient.Slices for identifier.identifier:mrn.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:mrn.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:mrn.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Patient.Slices for identifier.identifier:mrn.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:mrn.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:mrn.value This element is included in summaries. C 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.id 0..1 id Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 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
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.id 0..1 id Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element is included in summaries. C 0..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 dateTime Indicates if the individual is deceased or not
Patient.address This element is included in summaries. 0..* Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (required): The domestic partnership status of a person.

doco Documentation for this format

Terminology Bindings

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.

Constraints

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:

  • The element 1 is sliced based on the value of Patient.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Patient.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Patient.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Patient.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Example General: 123456
Patient.Slices for identifier.identifier:mrn This element is included in summaries. 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Patient.Slices for identifier.identifier:mrn.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:mrn.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Patient.Slices for identifier.identifier:mrn.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:mrn.value This element is included in summaries. C 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 dateTime Indicates if the individual is deceased or not
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (required): The domestic partnership status of a person.

doco Documentation for this format

Terminology Bindings

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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Patient.Slices for identifier 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Patient.Slices for identifier.identifier:senaiteId 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Patient.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Patient.Slices for identifier.identifier:senaiteId.use 1..1 code usual
Fixed Value: usual (no extensions allowed)
Patient.Slices for identifier.identifier:senaiteId.type 0..0 Description of identifier
Patient.Slices for identifier.identifier:senaiteId.system 1..1 uri Internal Patient ID namespace — mandatory; defaults to https://fhir.senaite.org/NamingSystem/patient-id
Patient.Slices for identifier.identifier:senaiteId.value 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Patient.Slices for identifier.identifier:senaiteId.period 0..0 Time period when id is/was valid for use
Patient.Slices for identifier.identifier:senaiteId.assigner 0..0 Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:mrn 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Patient.Slices for identifier.identifier:mrn.extension 0..0 Extension
Patient.Slices for identifier.identifier:mrn.use 1..1 code secondary
Fixed Value: secondary (no extensions allowed)
Patient.Slices for identifier.identifier:mrn.system 1..1 uri External Patient ID namespace — mandatory; the consumer's own registry URI, or the default https://fhir.senaite.org/NamingSystem/patient-mrn
Patient.Slices for identifier.identifier:mrn.value 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Patient.Slices for identifier.identifier:mrn.period 0..0 Time period when id is/was valid for use
Patient.Slices for identifier.identifier:mrn.assigner 0..0 Organization that issued id (may be just text)
Patient.name 1..* HumanName A name associated with the patient
Patient.name.text 0..0 Text representation of the full name
Patient.name.period 0..0 Time period when name was/is in use
Patient.telecom
Patient.telecom.period 0..0 Time period when the contact point was/is in use
Patient.gender 1..1 code male | female | other | unknown
Patient.birthDate 1..1 date The date of birth for the individual
Patient.deceased[x] 0..1 dateTime Indicates if the individual is deceased or not
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (required): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..0 Whether patient is part of a multiple birth
Patient.photo 0..0 Image of the patient
Patient.contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
Patient.communication 0..0 A language which may be used to communicate with the patient about his or her health
Patient.generalPractitioner 0..0 Patient's nominated primary care provider
Patient.managingOrganization 0..0 Organization that is the custodian of the patient record
Patient.link 0..0 Link to a Patient or RelatedPerson resource that concerns the same actual individual

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.maritalStatus Base required Marital Status Codes 📦5.0.0 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:estimatedDateBirth 0..1 boolean If the date of birth was not known precisely
URL: https://fhir.senaite.org/StructureDefinition/EstimatedDateBirth
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:use
Patient.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Patient ID — server-assigned, do not include on create
Patient.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Patient.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE patient identifier — alphanumeric and hyphens only
Example General: 123456
Patient.Slices for identifier.identifier:mrn This element is included in summaries. 0..1 Identifier External Patient ID from the consumer's system — may be supplied on create
Patient.Slices for identifier.identifier:mrn.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:mrn.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:mrn.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Patient.Slices for identifier.identifier:mrn.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:mrn.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:mrn.value This element is included in summaries. C 1..1 string External patient identifier, typically an MRN — alphanumeric and hyphens only
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.id 0..1 id Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 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
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.id 0..1 id Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element is included in summaries. C 0..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 dateTime Indicates if the individual is deceased or not
Patient.address This element is included in summaries. 0..* Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (required): The domestic partnership status of a person.

doco Documentation for this format

Terminology Bindings

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.

Constraints

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:

  • The element 1 is sliced based on the value of Patient.identifier

 

Other representations of profile: CSV, Excel, Schematron