Zambia Immunizations FHIR Implementation Guide
1.0.0 - STU1 Zambia flag

Zambia Immunizations FHIR Implementation Guide, published by Ministry of Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xhanti2309/Immunisation-IG/ and changes regularly. See the Directory of published versions

Resource Profile: Related Person - Chief at Birth

Official URL: http://openhie.org/fhir/zambia-immunizations/StructureDefinition/chief-at-birth-relation-to-patient Version: 1.0.0
Active as of 2024-08-13 Computable Name: ChiefAtBirthRelatedPerson

Used to record details of the chief at the time of the Patient's birth.

Usage:

Formal Views of Profile Content

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

This structure is derived from RelationToPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..* RelationToPatient A person that is related to a patient, but who is not a direct target of care
... patient 1..1 Reference(Patient - Smartcare Immunization Patient) The patient this person is related to
... relationship 1..1 CodeableConcept The relationship of the related person to the patient
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 303119007
... name
.... family 1..1 string Family name (often called 'Surname')

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..* RelationToPatient A person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier:NRC SΣ 0..1 Identifier A human identifier for this person
..... 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://openhie.org/fhir/zambia-immunizations/identifier/relative-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
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient - Smartcare Immunization Patient) The patient this person is related to
... relationship Σ 1..1 CodeableConcept The relationship of the related person to the patient
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 303119007
... name SΣ 0..* HumanName A name associated with the person
.... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 0..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 person
Slice: Unordered, Open by value:system
.... telecom:phone SΣ 0..1 ContactPoint A contact detail for the person
..... 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
PHONE-1: Only special characters (+) and numbers are allowed. For example: 0831231234, +27831231234
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RelatedPerson.identifier:NRC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.relationshippreferredPattern: SNOMED-CT Code 303119007
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
RelatedPerson.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
RelatedPerson.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
NRC-SmartcareID-1errorRelatedPerson.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}$')
PHONE-1errorRelatedPerson.telecom:phone.valueOnly special characters (+) and numbers are allowed. For example: 0831231234, +27831231234
: $this.matches('^[+]?{1}[0-9]{10,12}$')
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA 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
.. RelatedPerson 0..* RelationToPatient A person that is related to a patient, but who is not a direct target of care
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:NRC SΣ 0..1 Identifier A human identifier for this person
..... 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://openhie.org/fhir/zambia-immunizations/identifier/relative-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)
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient - Smartcare Immunization Patient) The patient this person is related to
... relationship Σ 1..1 CodeableConcept The relationship of the related person to the patient
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 303119007
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... name SΣ 0..* HumanName A name associated with the person
.... 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 Σ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 0..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 person
Slice: Unordered, Open by value:system
.... telecom:phone SΣ 0..1 ContactPoint A contact detail for the person
..... 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
PHONE-1: Only special characters (+) and numbers are allowed. For example: 0831231234, +27831231234
..... 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 Σ 0..1 date The date on which the related person was born
... address Σ 0..* Address Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with the related person about the patient's 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 related person about the patient's health
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RelatedPerson.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
RelatedPerson.identifier:NRC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:NRC.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshippreferredPattern: SNOMED-CT Code 303119007
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
RelatedPerson.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
RelatedPerson.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
RelatedPerson.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
NRC-SmartcareID-1errorRelatedPerson.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}$')
PHONE-1errorRelatedPerson.telecom:phone.valueOnly special characters (+) and numbers are allowed. For example: 0831231234, +27831231234
: $this.matches('^[+]?{1}[0-9]{10,12}$')
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA 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()

This structure is derived from RelationToPatient

Summary

Mandatory: 1 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

Differential View

This structure is derived from RelationToPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..* RelationToPatient A person that is related to a patient, but who is not a direct target of care
... patient 1..1 Reference(Patient - Smartcare Immunization Patient) The patient this person is related to
... relationship 1..1 CodeableConcept The relationship of the related person to the patient
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 303119007
... name
.... family 1..1 string Family name (often called 'Surname')

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..* RelationToPatient A person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier:NRC SΣ 0..1 Identifier A human identifier for this person
..... 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://openhie.org/fhir/zambia-immunizations/identifier/relative-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
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient - Smartcare Immunization Patient) The patient this person is related to
... relationship Σ 1..1 CodeableConcept The relationship of the related person to the patient
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 303119007
... name SΣ 0..* HumanName A name associated with the person
.... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 0..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 person
Slice: Unordered, Open by value:system
.... telecom:phone SΣ 0..1 ContactPoint A contact detail for the person
..... 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
PHONE-1: Only special characters (+) and numbers are allowed. For example: 0831231234, +27831231234
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RelatedPerson.identifier:NRC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.relationshippreferredPattern: SNOMED-CT Code 303119007
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
RelatedPerson.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
RelatedPerson.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
NRC-SmartcareID-1errorRelatedPerson.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}$')
PHONE-1errorRelatedPerson.telecom:phone.valueOnly special characters (+) and numbers are allowed. For example: 0831231234, +27831231234
: $this.matches('^[+]?{1}[0-9]{10,12}$')
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA 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
.. RelatedPerson 0..* RelationToPatient A person that is related to a patient, but who is not a direct target of care
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:NRC SΣ 0..1 Identifier A human identifier for this person
..... 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://openhie.org/fhir/zambia-immunizations/identifier/relative-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)
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient - Smartcare Immunization Patient) The patient this person is related to
... relationship Σ 1..1 CodeableConcept The relationship of the related person to the patient
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 303119007
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... name SΣ 0..* HumanName A name associated with the person
.... 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 Σ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 0..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 person
Slice: Unordered, Open by value:system
.... telecom:phone SΣ 0..1 ContactPoint A contact detail for the person
..... 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
PHONE-1: Only special characters (+) and numbers are allowed. For example: 0831231234, +27831231234
..... 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 Σ 0..1 date The date on which the related person was born
... address Σ 0..* Address Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with the related person about the patient's 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 related person about the patient's health
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RelatedPerson.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
RelatedPerson.identifier:NRC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:NRC.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshippreferredPattern: SNOMED-CT Code 303119007
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
RelatedPerson.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
RelatedPerson.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
RelatedPerson.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
NRC-SmartcareID-1errorRelatedPerson.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}$')
PHONE-1errorRelatedPerson.telecom:phone.valueOnly special characters (+) and numbers are allowed. For example: 0831231234, +27831231234
: $this.matches('^[+]?{1}[0-9]{10,12}$')
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA 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()

This structure is derived from RelationToPatient

Summary

Mandatory: 1 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron