Ethiopia FHIR Implementation Guide - HIV Treatment & Care Services
1.0.1 - ci-build Ethiopia flag

Ethiopia FHIR Implementation Guide - HIV Treatment & Care Services, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/ethiopia-hiv/ and changes regularly. See the Directory of published versions

Resource Profile: Patient

Official URL: http://moh.gov.et/fhir/hiv/StructureDefinition/patient Version: 1.0.1
Active as of 2024-10-14 Computable Name: EthPatient

Is used to document demographics and other administrative information about an individual receiving care or other health-related services.

Usage:

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... Slices for identifier 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:MRN 1..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/MRN
..... value C 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
.... identifier:UAN S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/UAN
..... value C 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
.... identifier:EMR-ID 1..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/SmartCareID
..... value C 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
... name 1..* HumanName A name associated with the patient
.... family 1..1 string Family name (often called 'Surname')
.... given 1..* string Given names (not always 'first'). Includes middle names
... gender 1..1 code male | female | other | unknown
... birthDate 1..1 date The date of birth for the individual
... address S 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... ResidentialType S 0..1 CodeableConcept Residential Type
URL: http://moh.gov.et/fhir/hiv/StructureDefinition/residential-type
Binding: Residential Type (required)
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district S 0..1 string District name (aka county)
.... state S 0..1 string Sub-unit of country (abbreviations ok)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
... managingOrganization 1..1 Reference(Organization) Organization that is the custodian of the patient record
... link S 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... other 1..1 Reference(Related Person - An individual Related to The Patient | Patient) The other patient or related person resource that the link refers to

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
MRN-UAN-EMR-ID-1errorPatient.identifier:MRN.value, Patient.identifier:UAN.value, Patient.identifier:EMR-ID.valueOnly letters, special characters (dash) and numbers are allowed.
: $this.matches('[A-Za-z0-9-]*')
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:MRN Σ 1..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/MRN
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
.... identifier:UAN SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/UAN
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
.... identifier:EMR-ID Σ 1..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/SmartCareID
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 1..* HumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family Σ 1..1 string Family name (often called 'Surname')
.... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... ResidentialType S 0..1 CodeableConcept Residential Type
URL: http://moh.gov.et/fhir/hiv/StructureDefinition/residential-type
Binding: Residential Type (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... managingOrganization Σ 1..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Related Person - An individual Related to The Patient | 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

PathConformanceValueSetURI
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:UAN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:EMR-ID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
MRN-UAN-EMR-ID-1errorPatient.identifier:MRN.value, Patient.identifier:UAN.value, Patient.identifier:EMR-ID.valueOnly letters, special characters (dash) and numbers are allowed.
: $this.matches('[A-Za-z0-9-]*')
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:MRN Σ 1..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/MRN
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:UAN SΣ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/UAN
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:EMR-ID Σ 1..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/SmartCareID
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 1..* HumanName A name associated with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string Family name (often called 'Surname')
.... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... ResidentialType S 0..1 CodeableConcept Residential Type
URL: http://moh.gov.et/fhir/hiv/StructureDefinition/residential-type
Binding: Residential Type (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 1..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Related Person - An individual Related to The Patient | 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

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:MRN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:UAN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:UAN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:EMR-ID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:EMR-ID.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
MRN-UAN-EMR-ID-1errorPatient.identifier:MRN.value, Patient.identifier:UAN.value, Patient.identifier:EMR-ID.valueOnly letters, special characters (dash) and numbers are allowed.
: $this.matches('[A-Za-z0-9-]*')
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL 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

Summary

Mandatory: 12 elements(2 nested mandatory elements)
Must-Support: 11 elements

Structures

This structure refers to these other structures:

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

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... Slices for identifier 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:MRN 1..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/MRN
..... value C 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
.... identifier:UAN S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/UAN
..... value C 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
.... identifier:EMR-ID 1..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/SmartCareID
..... value C 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
... name 1..* HumanName A name associated with the patient
.... family 1..1 string Family name (often called 'Surname')
.... given 1..* string Given names (not always 'first'). Includes middle names
... gender 1..1 code male | female | other | unknown
... birthDate 1..1 date The date of birth for the individual
... address S 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... ResidentialType S 0..1 CodeableConcept Residential Type
URL: http://moh.gov.et/fhir/hiv/StructureDefinition/residential-type
Binding: Residential Type (required)
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district S 0..1 string District name (aka county)
.... state S 0..1 string Sub-unit of country (abbreviations ok)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
... managingOrganization 1..1 Reference(Organization) Organization that is the custodian of the patient record
... link S 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... other 1..1 Reference(Related Person - An individual Related to The Patient | Patient) The other patient or related person resource that the link refers to

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
MRN-UAN-EMR-ID-1errorPatient.identifier:MRN.value, Patient.identifier:UAN.value, Patient.identifier:EMR-ID.valueOnly letters, special characters (dash) and numbers are allowed.
: $this.matches('[A-Za-z0-9-]*')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:MRN Σ 1..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/MRN
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
.... identifier:UAN SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/UAN
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
.... identifier:EMR-ID Σ 1..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/SmartCareID
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 1..* HumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family Σ 1..1 string Family name (often called 'Surname')
.... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... ResidentialType S 0..1 CodeableConcept Residential Type
URL: http://moh.gov.et/fhir/hiv/StructureDefinition/residential-type
Binding: Residential Type (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... managingOrganization Σ 1..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Related Person - An individual Related to The Patient | 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

PathConformanceValueSetURI
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:UAN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:EMR-ID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
MRN-UAN-EMR-ID-1errorPatient.identifier:MRN.value, Patient.identifier:UAN.value, Patient.identifier:EMR-ID.valueOnly letters, special characters (dash) and numbers are allowed.
: $this.matches('[A-Za-z0-9-]*')
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:MRN Σ 1..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/MRN
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:UAN SΣ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/UAN
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:EMR-ID Σ 1..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/SmartCareID
..... value ΣC 1..1 string The value that is unique
MRN-UAN-EMR-ID-1: Only letters, special characters (dash) and numbers are allowed.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 1..* HumanName A name associated with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string Family name (often called 'Surname')
.... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... ResidentialType S 0..1 CodeableConcept Residential Type
URL: http://moh.gov.et/fhir/hiv/StructureDefinition/residential-type
Binding: Residential Type (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 1..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Related Person - An individual Related to The Patient | 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

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:MRN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:UAN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:UAN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:EMR-ID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:EMR-ID.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
MRN-UAN-EMR-ID-1errorPatient.identifier:MRN.value, Patient.identifier:UAN.value, Patient.identifier:EMR-ID.valueOnly letters, special characters (dash) and numbers are allowed.
: $this.matches('[A-Za-z0-9-]*')
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL 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

Summary

Mandatory: 12 elements(2 nested mandatory elements)
Must-Support: 11 elements

Structures

This structure refers to these other structures:

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