Zambia Immunizations FHIR Implementation Guide
1.0.1 - ci-build Zambia flag

Zambia Immunizations FHIR Implementation Guide, 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/Zambia-Immunizations/ and changes regularly. See the Directory of published versions

Resource Profile: Patient - HPV Immunization Patient

Official URL: http://moh.gov.zm/fhir/immunizations/StructureDefinition/hpv-immunization-patient Version: 1.0.1
Active as of 2024-09-30 Computable Name: HPVImmunizationPatient

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 ImmunizationPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient ImmunizationPatient
... Slices for identifier Content/Rules for all slices
.... identifier:CN 1..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.zm/fhir/immunizations/identifier/patient-card-number
..... value 1..1 string The value that is unique
.... identifier:PN S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.zm/fhir/immunizations/identifier/patient-passport
..... value C 1..1 string The value that is unique
Passport-1: Only alphabetical characters and numbers are allowed. For example: AA01234567
... name
.... family 1..1 string Family name (often called 'Surname')
.... given 1..* string Given names (not always 'first'). Includes middle names
... Slices for link Content/Rules for all slices
.... link:RelatedPerson 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
..... other 1..1 Reference(Related Person - Guardian Relation to Patient Profile (HPV)) The other patient or related person resource that the link refers to

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
Passport-1errorPatient.identifier:PN.valueOnly alphabetical characters and numbers are allowed. For example: AA01234567
: $this.matches('^[a-zA-Z]{2,3}[0-9]{8,12}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ImmunizationPatient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... sex 1..1 CodeableConcept Administrative Sex
URL: http://moh.gov.zm/fhir/immunizations/StructureDefinition/administrative-sex
Binding: Administrative Sex (required)
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NRC 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.zm/fhir/immunizations/identifier/patient-nrc
..... value ΣC 1..1 string The value that is unique
NRC-SmartcareID-1: Only special characters (forward slash) and numbers are allowed. For example: 999999/99/9
Example General: 123456
.... identifier:CN Σ 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.zm/fhir/immunizations/identifier/patient-card-number
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:PN 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.zm/fhir/immunizations/identifier/patient-passport
..... value ΣC 1..1 string The value that is unique
Passport-1: Only alphabetical characters and numbers are allowed. For example: AA01234567
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name ΣC 1..* HumanName A name associated with the patient
PatientName-Smartcare-1: If name.use is NOT nickname then name.family SHALL be present.
PatientName-Smartcare-2: If name.use is nickname then name.text SHALL be present.
.... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 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
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..* ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value ΣC 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... telecom:phone SΣ 0..* ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... 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
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


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)
.... country SΣ 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.

... managingOrganization SΣ 0..1 Reference(Organization - Healthcare Service Provider Profile) Organization that is the custodian of the patient record
... Slices for link ?!SΣ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by profile:other.resolve(), type:other.type
.... link:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

.... link:RelatedPerson ?!SΣ 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... other Σ 1..1 Reference(Related Person - Guardian Relation to Patient Profile (HPV)) The other patient or related person resource that the link refers to
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Required Pattern: RelatedPerson
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NRC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:CN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:PN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
Patient.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard
Patient.link:RelatedPerson.other.typeextensiblePattern: RelatedPerson
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Patient.link:RelatedPerson.typerequiredPattern: seealso
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
NRC-SmartcareID-1errorPatient.identifier:NRC.valueOnly special characters (forward slash) and numbers are allowed. For example: 999999/99/9
: $this.matches('^[0-9]{1,6}/[0-9]{1,2}/[0-9]{1}$')
Passport-1errorPatient.identifier:PN.valueOnly alphabetical characters and numbers are allowed. For example: AA01234567
: $this.matches('^[a-zA-Z]{2,3}[0-9]{8,12}$')
PatientName-Smartcare-1errorPatient.nameIf name.use is NOT nickname then name.family SHALL be present.
: use.exists() and use != 'nickname' implies family.exists() and given.exists()
PatientName-Smartcare-2errorPatient.nameIf name.use is nickname then name.text SHALL be present.
: use.exists() and use = 'nickname' implies text.exists()
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().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-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..* ImmunizationPatient 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... sex 1..1 CodeableConcept Administrative Sex
URL: http://moh.gov.zm/fhir/immunizations/StructureDefinition/administrative-sex
Binding: Administrative Sex (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NRC SΣ 0..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 ?!Σ 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: IdentifierTypeCodes (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.zm/fhir/immunizations/identifier/patient-nrc
..... value ΣC 1..1 string The value that is unique
NRC-SmartcareID-1: Only special characters (forward slash) and numbers are allowed. For example: 999999/99/9
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:CN Σ 1..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 ?!Σ 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: IdentifierTypeCodes (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.zm/fhir/immunizations/identifier/patient-card-number
..... value ΣC 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PN SΣ 0..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 ?!Σ 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: IdentifierTypeCodes (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.zm/fhir/immunizations/identifier/patient-passport
..... value ΣC 1..1 string The value that is unique
Passport-1: Only alphabetical characters and numbers are allowed. For example: AA01234567
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 ΣC 1..* HumanName A name associated with the patient
PatientName-Smartcare-1: If name.use is NOT nickname then name.family SHALL be present.
PatientName-Smartcare-2: If name.use is nickname then name.text SHALL be present.
.... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 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
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..* ContactPoint A contact detail for the individual
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value ΣC 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:phone SΣ 0..* ContactPoint A contact detail for the individual
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..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 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


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 SΣ 0..1 string Country (e.g. may 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: MaritalStatusCodes (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 C 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
.... address C 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization SΣ 0..1 Reference(Organization - Healthcare Service Provider Profile) Organization that is the custodian of the patient record
... Slices for link ?!SΣ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by profile:other.resolve(), type:other.type
.... link:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

.... link:RelatedPerson ?!SΣ 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
..... 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 - Guardian Relation to Patient Profile (HPV)) The other patient or related person resource that the link refers to
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Required Pattern: RelatedPerson
...... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
...... display ΣC 0..1 string Text alternative for the resource
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.identifier:NRC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:NRC.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:CN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:CN.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:PN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:PN.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
Patient.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|5.0.0
from the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
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|5.0.0
from the FHIR Standard
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard
Patient.link:RelatedPerson.other.typeextensiblePattern: RelatedPerson
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Patient.link:RelatedPerson.typerequiredPattern: seealso
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
NRC-SmartcareID-1errorPatient.identifier:NRC.valueOnly special characters (forward slash) and numbers are allowed. For example: 999999/99/9
: $this.matches('^[0-9]{1,6}/[0-9]{1,2}/[0-9]{1}$')
Passport-1errorPatient.identifier:PN.valueOnly alphabetical characters and numbers are allowed. For example: AA01234567
: $this.matches('^[a-zA-Z]{2,3}[0-9]{8,12}$')
PatientName-Smartcare-1errorPatient.nameIf name.use is NOT nickname then name.family SHALL be present.
: use.exists() and use != 'nickname' implies family.exists() and given.exists()
PatientName-Smartcare-2errorPatient.nameIf name.use is nickname then name.text SHALL be present.
: use.exists() and use = 'nickname' implies text.exists()
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().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-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 ImmunizationPatient

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from ImmunizationPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient ImmunizationPatient
... Slices for identifier Content/Rules for all slices
.... identifier:CN 1..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.zm/fhir/immunizations/identifier/patient-card-number
..... value 1..1 string The value that is unique
.... identifier:PN S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.zm/fhir/immunizations/identifier/patient-passport
..... value C 1..1 string The value that is unique
Passport-1: Only alphabetical characters and numbers are allowed. For example: AA01234567
... name
.... family 1..1 string Family name (often called 'Surname')
.... given 1..* string Given names (not always 'first'). Includes middle names
... Slices for link Content/Rules for all slices
.... link:RelatedPerson 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
..... other 1..1 Reference(Related Person - Guardian Relation to Patient Profile (HPV)) The other patient or related person resource that the link refers to

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
Passport-1errorPatient.identifier:PN.valueOnly alphabetical characters and numbers are allowed. For example: AA01234567
: $this.matches('^[a-zA-Z]{2,3}[0-9]{8,12}$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ImmunizationPatient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... sex 1..1 CodeableConcept Administrative Sex
URL: http://moh.gov.zm/fhir/immunizations/StructureDefinition/administrative-sex
Binding: Administrative Sex (required)
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NRC 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.zm/fhir/immunizations/identifier/patient-nrc
..... value ΣC 1..1 string The value that is unique
NRC-SmartcareID-1: Only special characters (forward slash) and numbers are allowed. For example: 999999/99/9
Example General: 123456
.... identifier:CN Σ 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.zm/fhir/immunizations/identifier/patient-card-number
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:PN 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.zm/fhir/immunizations/identifier/patient-passport
..... value ΣC 1..1 string The value that is unique
Passport-1: Only alphabetical characters and numbers are allowed. For example: AA01234567
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name ΣC 1..* HumanName A name associated with the patient
PatientName-Smartcare-1: If name.use is NOT nickname then name.family SHALL be present.
PatientName-Smartcare-2: If name.use is nickname then name.text SHALL be present.
.... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 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
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..* ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value ΣC 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... telecom:phone SΣ 0..* ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... 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
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


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)
.... country SΣ 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.

... managingOrganization SΣ 0..1 Reference(Organization - Healthcare Service Provider Profile) Organization that is the custodian of the patient record
... Slices for link ?!SΣ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by profile:other.resolve(), type:other.type
.... link:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

.... link:RelatedPerson ?!SΣ 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... other Σ 1..1 Reference(Related Person - Guardian Relation to Patient Profile (HPV)) The other patient or related person resource that the link refers to
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Required Pattern: RelatedPerson
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NRC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:CN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:PN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
Patient.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard
Patient.link:RelatedPerson.other.typeextensiblePattern: RelatedPerson
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Patient.link:RelatedPerson.typerequiredPattern: seealso
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
NRC-SmartcareID-1errorPatient.identifier:NRC.valueOnly special characters (forward slash) and numbers are allowed. For example: 999999/99/9
: $this.matches('^[0-9]{1,6}/[0-9]{1,2}/[0-9]{1}$')
Passport-1errorPatient.identifier:PN.valueOnly alphabetical characters and numbers are allowed. For example: AA01234567
: $this.matches('^[a-zA-Z]{2,3}[0-9]{8,12}$')
PatientName-Smartcare-1errorPatient.nameIf name.use is NOT nickname then name.family SHALL be present.
: use.exists() and use != 'nickname' implies family.exists() and given.exists()
PatientName-Smartcare-2errorPatient.nameIf name.use is nickname then name.text SHALL be present.
: use.exists() and use = 'nickname' implies text.exists()
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().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-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..* ImmunizationPatient 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... sex 1..1 CodeableConcept Administrative Sex
URL: http://moh.gov.zm/fhir/immunizations/StructureDefinition/administrative-sex
Binding: Administrative Sex (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NRC SΣ 0..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 ?!Σ 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: IdentifierTypeCodes (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.zm/fhir/immunizations/identifier/patient-nrc
..... value ΣC 1..1 string The value that is unique
NRC-SmartcareID-1: Only special characters (forward slash) and numbers are allowed. For example: 999999/99/9
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:CN Σ 1..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 ?!Σ 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: IdentifierTypeCodes (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.zm/fhir/immunizations/identifier/patient-card-number
..... value ΣC 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PN SΣ 0..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 ?!Σ 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: IdentifierTypeCodes (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.zm/fhir/immunizations/identifier/patient-passport
..... value ΣC 1..1 string The value that is unique
Passport-1: Only alphabetical characters and numbers are allowed. For example: AA01234567
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 ΣC 1..* HumanName A name associated with the patient
PatientName-Smartcare-1: If name.use is NOT nickname then name.family SHALL be present.
PatientName-Smartcare-2: If name.use is nickname then name.text SHALL be present.
.... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 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
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..* ContactPoint A contact detail for the individual
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value ΣC 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:phone SΣ 0..* ContactPoint A contact detail for the individual
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..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 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


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 SΣ 0..1 string Country (e.g. may 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: MaritalStatusCodes (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 C 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
.... address C 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization SΣ 0..1 Reference(Organization - Healthcare Service Provider Profile) Organization that is the custodian of the patient record
... Slices for link ?!SΣ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by profile:other.resolve(), type:other.type
.... link:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

.... link:RelatedPerson ?!SΣ 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
..... 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 - Guardian Relation to Patient Profile (HPV)) The other patient or related person resource that the link refers to
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 1..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Required Pattern: RelatedPerson
...... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
...... display ΣC 0..1 string Text alternative for the resource
..... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.identifier:NRC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:NRC.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:CN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:CN.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:PN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:PN.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
Patient.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|5.0.0
from the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
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|5.0.0
from the FHIR Standard
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard
Patient.link:RelatedPerson.other.typeextensiblePattern: RelatedPerson
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Patient.link:RelatedPerson.typerequiredPattern: seealso
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
NRC-SmartcareID-1errorPatient.identifier:NRC.valueOnly special characters (forward slash) and numbers are allowed. For example: 999999/99/9
: $this.matches('^[0-9]{1,6}/[0-9]{1,2}/[0-9]{1}$')
Passport-1errorPatient.identifier:PN.valueOnly alphabetical characters and numbers are allowed. For example: AA01234567
: $this.matches('^[a-zA-Z]{2,3}[0-9]{8,12}$')
PatientName-Smartcare-1errorPatient.nameIf name.use is NOT nickname then name.family SHALL be present.
: use.exists() and use != 'nickname' implies family.exists() and given.exists()
PatientName-Smartcare-2errorPatient.nameIf name.use is nickname then name.text SHALL be present.
: use.exists() and use = 'nickname' implies text.exists()
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().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-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 ImmunizationPatient

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron