WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: SMART Guidelines Immunizations Caregiver (RelatedPerson)

Caregiver (RelatedPerson) Profile for the Immunizations SMART Guidelines. From IMMZ.C Client Registration for IMMZ.C4.Create client record OR IMMZ.C5.3.Update client details.

Usages:

• Examples for this Profile: RelatedPerson/IMMZ.C.Caregiver.1

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(SMART Guidelines Immunizations Patient)	The patient this person is related to
relationship	Σ	1..1	CodeableConcept	The nature of the relationship 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://terminology.hl7.org/5.1.0/CodeSystem-v3-RoleClass.html
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: CAREGIVER
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	Σ	1..*	HumanName	A name associated with the person
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	1..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RelatedPerson.relationship	preferred	Pattern Value: CAREGIVER http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1 From the FHIR Standard
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
patient		1..1	Reference(SMART Guidelines Immunizations Patient)	The patient this person is related to
relationship		1..1	CodeableConcept	The nature of the relationship 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://terminology.hl7.org/5.1.0/CodeSystem-v3-RoleClass.html
code		1..1	code	Symbol in syntax defined by the system Fixed Value: CAREGIVER
name		1..*	HumanName	A name associated with the person
text		1..1	string	Text representation of the full name
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(SMART Guidelines Immunizations Patient)	The patient this person is related to
relationship	Σ	1..1	CodeableConcept	The nature of the relationship 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://terminology.hl7.org/5.1.0/CodeSystem-v3-RoleClass.html
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: CAREGIVER
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	Σ	1..*	HumanName	A name associated with the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	1..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the person
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 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 patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RelatedPerson.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	Pattern Value: CAREGIVER http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1 From the FHIR Standard
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from RelatedPerson

Summary

Mandatory: 3 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• SMART Guidelines Immunizations Patient (http://smart.who.int/immunizations/StructureDefinition/IMMZ.Patient)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(SMART Guidelines Immunizations Patient)	The patient this person is related to
relationship	Σ	1..1	CodeableConcept	The nature of the relationship 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://terminology.hl7.org/5.1.0/CodeSystem-v3-RoleClass.html
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: CAREGIVER
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	Σ	1..*	HumanName	A name associated with the person
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	1..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RelatedPerson.relationship	preferred	Pattern Value: CAREGIVER http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1 From the FHIR Standard
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
patient		1..1	Reference(SMART Guidelines Immunizations Patient)	The patient this person is related to
relationship		1..1	CodeableConcept	The nature of the relationship 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://terminology.hl7.org/5.1.0/CodeSystem-v3-RoleClass.html
code		1..1	code	Symbol in syntax defined by the system Fixed Value: CAREGIVER
name		1..*	HumanName	A name associated with the person
text		1..1	string	Text representation of the full name
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(SMART Guidelines Immunizations Patient)	The patient this person is related to
relationship	Σ	1..1	CodeableConcept	The nature of the relationship 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://terminology.hl7.org/5.1.0/CodeSystem-v3-RoleClass.html
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: CAREGIVER
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	Σ	1..*	HumanName	A name associated with the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	1..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the person
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 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 patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RelatedPerson.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	Pattern Value: CAREGIVER http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1 From the FHIR Standard
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from RelatedPerson

Summary

Mandatory: 3 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• SMART Guidelines Immunizations Patient (http://smart.who.int/immunizations/StructureDefinition/IMMZ.Patient)

Other representations of profile: CSV, Excel, Schematron