SIL HIE Implementation Guide
0.1.0 - sil-hie-active

SIL HIE Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions

Resource Profile: HIE Patient

Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/hie-patient Version: 0.1.0
Active as of 2025-11-25 Computable Name: HIEPatient

R4B Patient constrained for HIE workflows.

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: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier An identifier for this patient
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 1..1 HIECodeableConcept Description of identifier
Binding: HIE Person Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... assigner SΣ 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... name SΣ 1..1 HIEHumanName A name associated with the patient
... telecom SΣ 0..* HIEContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 0..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
... maritalStatus S 0..1 HIECodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... contact SC 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
.... relationship S 1..* HIECodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible)
.... telecom 1..* HIEContactPoint A contact detail for the person
.... organization C 0..1 HIEReference(HIE Organization) Organization that is associated with the contact
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 HIECodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (extensible)
... generalPractitioner S 0..* HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) Patient's nominated primary care provider
... managingOrganization SΣ 1..1 HIEReference(HIE Organization) Organization that is the custodian of the patient record
... 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 HIEReference(HIE Patient) 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Patient.identifier.type Base required HIE Person Identifier Types 📦0.1.0 This IG
Patient.gender Base required AdministrativeGender 📦4.3.0 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.3.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.3.0 FHIR Std.
Patient.communication.​language Base extensible All Languages 📦4.3.0 FHIR Std.
Patient.link.type Base required LinkType 📍4.3.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.exists() and ('#'+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(uri) = '#').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()
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 Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... text
.... status 1..1 code generated | extensions | additional | empty
Required Pattern: generated
... identifier 1..* Identifier An identifier for this patient
.... use 1..1 code usual | official | temp | secondary | old (If known)
.... type 1..1 HIECodeableConcept Description of identifier
Binding: HIE Person Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... assigner S 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... active S 1..1 boolean Whether this patient's record is in active use
... telecom S 0..* HIEContactPoint A contact detail for the individual
... gender 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S 0..1 date The date of birth for the individual
... maritalStatus S 0..1 HIECodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... contact S 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
.... relationship S 1..* HIECodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible)
.... telecom 1..* HIEContactPoint A contact detail for the person
.... organization 0..1 HIEReference(HIE Organization) Organization that is associated with the contact
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... language S 1..1 HIECodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (extensible)
... generalPractitioner S 0..* HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) Patient's nominated primary care provider
... managingOrganization S 1..1 HIEReference(HIE Organization) Organization that is the custodian of the patient record
... link
.... other 1..1 HIEReference(HIE Patient) The other patient or related person resource that the link refers to

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier.type Base required HIE Person Identifier Types 📦0.1.0 This IG
Patient.gender Base required AdministrativeGender 📦4.3.0 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.3.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.3.0 FHIR Std.
Patient.communication.​language Base extensible All Languages 📦4.3.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal 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
... 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
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
Required Pattern: generated
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier An identifier for this patient
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 1..1 HIECodeableConcept Description of identifier
Binding: HIE Person Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether this patient's record is in active use
... name SΣ 1..1 HIEHumanName A name associated with the patient
... telecom SΣ 0..* HIEContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 0..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 Σ 0..* Address An address for the individual
... maritalStatus S 0..1 HIECodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact SC 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 S 1..* HIECodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 1..* HIEContactPoint 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 HIEReference(HIE 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 S 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 S 1..1 HIECodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) Patient's nominated primary care provider
... managingOrganization SΣ 1..1 HIEReference(HIE 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 HIEReference(HIE Patient) 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Patient.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Patient.identifier.type Base required HIE Person Identifier Types 📦0.1.0 This IG
Patient.gender Base required AdministrativeGender 📦4.3.0 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.3.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.3.0 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.3.0 FHIR Std.
Patient.communication.​language Base extensible All Languages 📦4.3.0 FHIR Std.
Patient.link.type Base required LinkType 📍4.3.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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Patient.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()
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()
txt-1 error Patient.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Patient.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier An identifier for this patient
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 1..1 HIECodeableConcept Description of identifier
Binding: HIE Person Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... assigner SΣ 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... name SΣ 1..1 HIEHumanName A name associated with the patient
... telecom SΣ 0..* HIEContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 0..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
... maritalStatus S 0..1 HIECodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... contact SC 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
.... relationship S 1..* HIECodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible)
.... telecom 1..* HIEContactPoint A contact detail for the person
.... organization C 0..1 HIEReference(HIE Organization) Organization that is associated with the contact
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 HIECodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (extensible)
... generalPractitioner S 0..* HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) Patient's nominated primary care provider
... managingOrganization SΣ 1..1 HIEReference(HIE Organization) Organization that is the custodian of the patient record
... 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 HIEReference(HIE Patient) 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Patient.identifier.type Base required HIE Person Identifier Types 📦0.1.0 This IG
Patient.gender Base required AdministrativeGender 📦4.3.0 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.3.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.3.0 FHIR Std.
Patient.communication.​language Base extensible All Languages 📦4.3.0 FHIR Std.
Patient.link.type Base required LinkType 📍4.3.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.exists() and ('#'+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(uri) = '#').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()
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 Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... text
.... status 1..1 code generated | extensions | additional | empty
Required Pattern: generated
... identifier 1..* Identifier An identifier for this patient
.... use 1..1 code usual | official | temp | secondary | old (If known)
.... type 1..1 HIECodeableConcept Description of identifier
Binding: HIE Person Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... assigner S 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... active S 1..1 boolean Whether this patient's record is in active use
... telecom S 0..* HIEContactPoint A contact detail for the individual
... gender 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S 0..1 date The date of birth for the individual
... maritalStatus S 0..1 HIECodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... contact S 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
.... relationship S 1..* HIECodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible)
.... telecom 1..* HIEContactPoint A contact detail for the person
.... organization 0..1 HIEReference(HIE Organization) Organization that is associated with the contact
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... language S 1..1 HIECodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (extensible)
... generalPractitioner S 0..* HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) Patient's nominated primary care provider
... managingOrganization S 1..1 HIEReference(HIE Organization) Organization that is the custodian of the patient record
... link
.... other 1..1 HIEReference(HIE Patient) The other patient or related person resource that the link refers to

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier.type Base required HIE Person Identifier Types 📦0.1.0 This IG
Patient.gender Base required AdministrativeGender 📦4.3.0 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.3.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.3.0 FHIR Std.
Patient.communication.​language Base extensible All Languages 📦4.3.0 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal 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
... 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
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
Required Pattern: generated
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier An identifier for this patient
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 1..1 HIECodeableConcept Description of identifier
Binding: HIE Person Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether this patient's record is in active use
... name SΣ 1..1 HIEHumanName A name associated with the patient
... telecom SΣ 0..* HIEContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 0..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 Σ 0..* Address An address for the individual
... maritalStatus S 0..1 HIECodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact SC 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 S 1..* HIECodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 1..* HIEContactPoint 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 HIEReference(HIE 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 S 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 S 1..1 HIECodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) Patient's nominated primary care provider
... managingOrganization SΣ 1..1 HIEReference(HIE 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 HIEReference(HIE Patient) 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Patient.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Patient.identifier.type Base required HIE Person Identifier Types 📦0.1.0 This IG
Patient.gender Base required AdministrativeGender 📦4.3.0 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.3.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.3.0 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.3.0 FHIR Std.
Patient.communication.​language Base extensible All Languages 📦4.3.0 FHIR Std.
Patient.link.type Base required LinkType 📍4.3.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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Patient.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()
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()
txt-1 error Patient.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Patient.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron