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

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

Resource Profile: Organization - Healthcare Service Provider Profile

An organization that provides healthcare services.

Usage:

• Use this Resource Profile: Bundle - HPV
• Refer to this Resource Profile: Patient - Generic Patient Profile for Immunizations, List - Medical History, Encounter - Target Facility Encounter, Immunization - Generic Vaccine Administration Profile and Immunization Recommendation - Vaccine Next Dose Date
• Examples for this Resource Profile: facility name, Facility one and facility name

Formal Views of Profile Content

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

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

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints
Organization			Organization
Slices for identifier		0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:XX		0..1	Identifier	Identifies this organization across multiple systems
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: XX
text		0..1	string	Plain text representation of the concept Required Pattern: Healthcare service provider identifier
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.gov.zm/fhir/immunizations/identifier/healthcare-service-provider
value		1..1	string	The value that is unique
type	S	0..1	CodeableConcept	Kind of organization Binding: Vaccination site types (Proprietary) (extensible)
name		1..1	string	Name used for the organization
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.type	extensible	VSProprietaryVaccinationSiteTypes http://moh.gov.zm/fhir/immunizations/ValueSet/vs-proprietary-vaccination-site-type from this IG

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
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
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:XX	ΣC	0..1	Identifier	Identifies this organization across multiple systems
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/healthcare-service-provider
value	ΣC	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SΣ	0..1	CodeableConcept	Kind of organization Binding: Vaccination site types (Proprietary) (extensible)
name	ΣC	1..1	string	Name used for the organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.identifier:XX.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.type	extensible	VSProprietaryVaccinationSiteTypes http://moh.gov.zm/fhir/immunizations/ValueSet/vs-proprietary-vaccination-site-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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().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-4	error	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	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()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
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	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:XX	ΣC	0..1	Identifier	Identifies this organization across multiple systems
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.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: XX
display	ΣC	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 Required Pattern: Healthcare service provider identifier
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.gov.zm/fhir/immunizations/identifier/healthcare-service-provider
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)
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SΣ	0..1	CodeableConcept	Kind of organization Binding: Vaccination site types (Proprietary) (extensible)
name	ΣC	1..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
description	Σ	0..1	markdown	Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
contact	C	0..*	ExtendedContactDetail	Official contact details for the Organization org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home'
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
qualification		0..*	BackboneElement	Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
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
identifier		0..*	Identifier	An identifier for this qualification for the organization
code		1..1	CodeableConcept	Coded representation of the qualification Binding Description (No ValueSet): (example): Specific qualification the organization has to provide a service.
period		0..1	Period	Period during which the qualification is valid
issuer		0..1	Reference(Organization)	Organization that regulates and issues the qualification
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Organization.identifier:XX.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.identifier:XX.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	extensible	VSProprietaryVaccinationSiteTypes http://moh.gov.zm/fhir/immunizations/ValueSet/vs-proprietary-vaccination-site-type from this IG
Organization.qualification.code	example

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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().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-4	error	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	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()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-3	error	Organization.contact	The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty()
org-4	error	Organization.contact	The address of an organization can never be of use 'home' : address.where(use = 'home').empty()

This structure is derived from Organization

Summary

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

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Organization.identifier

Differential View

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints
Organization			Organization
Slices for identifier		0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:XX		0..1	Identifier	Identifies this organization across multiple systems
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: XX
text		0..1	string	Plain text representation of the concept Required Pattern: Healthcare service provider identifier
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.gov.zm/fhir/immunizations/identifier/healthcare-service-provider
value		1..1	string	The value that is unique
type	S	0..1	CodeableConcept	Kind of organization Binding: Vaccination site types (Proprietary) (extensible)
name		1..1	string	Name used for the organization
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.type	extensible	VSProprietaryVaccinationSiteTypes http://moh.gov.zm/fhir/immunizations/ValueSet/vs-proprietary-vaccination-site-type from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
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
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:XX	ΣC	0..1	Identifier	Identifies this organization across multiple systems
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/healthcare-service-provider
value	ΣC	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SΣ	0..1	CodeableConcept	Kind of organization Binding: Vaccination site types (Proprietary) (extensible)
name	ΣC	1..1	string	Name used for the organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.identifier:XX.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.type	extensible	VSProprietaryVaccinationSiteTypes http://moh.gov.zm/fhir/immunizations/ValueSet/vs-proprietary-vaccination-site-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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().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-4	error	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	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()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
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	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:XX	ΣC	0..1	Identifier	Identifies this organization across multiple systems
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.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: XX
display	ΣC	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 Required Pattern: Healthcare service provider identifier
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.gov.zm/fhir/immunizations/identifier/healthcare-service-provider
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)
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SΣ	0..1	CodeableConcept	Kind of organization Binding: Vaccination site types (Proprietary) (extensible)
name	ΣC	1..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
description	Σ	0..1	markdown	Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
contact	C	0..*	ExtendedContactDetail	Official contact details for the Organization org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home'
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
qualification		0..*	BackboneElement	Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
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
identifier		0..*	Identifier	An identifier for this qualification for the organization
code		1..1	CodeableConcept	Coded representation of the qualification Binding Description (No ValueSet): (example): Specific qualification the organization has to provide a service.
period		0..1	Period	Period during which the qualification is valid
issuer		0..1	Reference(Organization)	Organization that regulates and issues the qualification
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Organization.identifier:XX.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.identifier:XX.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	extensible	VSProprietaryVaccinationSiteTypes http://moh.gov.zm/fhir/immunizations/ValueSet/vs-proprietary-vaccination-site-type from this IG
Organization.qualification.code	example

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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().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-4	error	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	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()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-3	error	Organization.contact	The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty()
org-4	error	Organization.contact	The address of an organization can never be of use 'home' : address.where(use = 'home').empty()

This structure is derived from Organization

Summary

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

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Organization.identifier

Other representations of profile: CSV, Excel, Schematron