NPHCDA Immunization FHIR IG
0.7.0 - ci-build
NPHCDA Immunization FHIR IG
0.7.0 - ci-build
NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.7.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions
| Official URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/ng-imm-practitionerrole | Version: 0.7.0 | |||
| Draft as of 2025-09-26 | Computable Name: NgImmPractitionerRole | |||
Defines the role(s) of a Nigerian healthcare practitioner in the immunization context. Links a Practitioner to an Organization, specifies their role, contact details, and periods of service, with constraints to support the Nigeria Immunization IG.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
  period |
S | 0..1 | Period | Period during which the practitioner is performing this role |
 practitioner |
S | 1..1 | Reference(NG-Imm Practitioner) | Practitioner linked to this role |
| organization |
S | 1..1 | Reference(NG-Imm Organization) | Organization the practitioner is associated with |
 code |
S | 1..* | CodeableConcept | Roles of the practitioner |
  text |
1..1 | string | Plain text description of role | |
| location |
S | 0..* | Reference(Location) | Locations where the practitioner role is performed |
| healthcareService |
S | 0..* | Reference(HealthcareService) | Services provided |
| availableTime |
0..0 | |||
| notAvailable |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 period |
SΣ | 0..1 | Period | Period during which the practitioner is performing this role |
| practitioner |
SΣ | 1..1 | Reference(NG-Imm Practitioner) | Practitioner linked to this role |
| organization |
SΣ | 1..1 | Reference(NG-Imm Organization) | Organization the practitioner is associated with |
| code |
SΣ | 1..* | CodeableConcept | Roles of the practitioner Binding: PractitionerRole (example): The role a person plays representing an organization. |
| text |
Σ | 1..1 | string | Plain text description of role |
| location |
SΣ | 0..* | Reference(Location) | Locations where the practitioner role is performed |
| healthcareService |
S | 0..* | Reference(HealthcareService) | Services provided |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | 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 | PractitionerRole | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | 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() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
| 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.
| |||||
| 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 | Business Identifiers that are specific to a role/location | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
| period |
SΣ | 0..1 | Period | Period during which the practitioner is performing this role | ||||
| practitioner |
SΣ | 1..1 | Reference(NG-Imm Practitioner) | Practitioner linked to this role | ||||
| organization |
SΣ | 1..1 | Reference(NG-Imm Organization) | Organization the practitioner is associated with | ||||
| code |
SΣ | 1..* | CodeableConcept | Roles of the practitioner Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
| id |
0..1 | string | 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 | ||||
| text |
Σ | 1..1 | string | Plain text description of role | ||||
| specialty |
Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
| location |
SΣ | 0..* | Reference(Location) | Locations where the practitioner role is performed | ||||
| healthcareService |
S | 0..* | Reference(HealthcareService) | Services provided | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role|4.0.1From the FHIR Standard | ||||
| PractitionerRole.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1From the FHIR Standard | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | 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 | PractitionerRole | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | 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 PractitionerRole
Differential View
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| period |
S | 0..1 | Period | Period during which the practitioner is performing this role |
| practitioner |
S | 1..1 | Reference(NG-Imm Practitioner) | Practitioner linked to this role |
| organization |
S | 1..1 | Reference(NG-Imm Organization) | Organization the practitioner is associated with |
| code |
S | 1..* | CodeableConcept | Roles of the practitioner |
| text |
1..1 | string | Plain text description of role | |
| location |
S | 0..* | Reference(Location) | Locations where the practitioner role is performed |
| healthcareService |
S | 0..* | Reference(HealthcareService) | Services provided |
| availableTime |
0..0 | |||
| notAvailable |
0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| period |
SΣ | 0..1 | Period | Period during which the practitioner is performing this role |
| practitioner |
SΣ | 1..1 | Reference(NG-Imm Practitioner) | Practitioner linked to this role |
| organization |
SΣ | 1..1 | Reference(NG-Imm Organization) | Organization the practitioner is associated with |
| code |
SΣ | 1..* | CodeableConcept | Roles of the practitioner Binding: PractitionerRole (example): The role a person plays representing an organization. |
| text |
Σ | 1..1 | string | Plain text description of role |
| location |
SΣ | 0..* | Reference(Location) | Locations where the practitioner role is performed |
| healthcareService |
S | 0..* | Reference(HealthcareService) | Services provided |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | 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 | PractitionerRole | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
| 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.
| |||||
| 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 | Business Identifiers that are specific to a role/location | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
| period |
SΣ | 0..1 | Period | Period during which the practitioner is performing this role | ||||
| practitioner |
SΣ | 1..1 | Reference(NG-Imm Practitioner) | Practitioner linked to this role | ||||
| organization |
SΣ | 1..1 | Reference(NG-Imm Organization) | Organization the practitioner is associated with | ||||
| code |
SΣ | 1..* | CodeableConcept | Roles of the practitioner Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
| id |
0..1 | string | 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 | ||||
| text |
Σ | 1..1 | string | Plain text description of role | ||||
| specialty |
Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
| location |
SΣ | 0..* | Reference(Location) | Locations where the practitioner role is performed | ||||
| healthcareService |
S | 0..* | Reference(HealthcareService) | Services provided | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role|4.0.1From the FHIR Standard | ||||
| PractitionerRole.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1From the FHIR Standard | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | 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 | PractitionerRole | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | 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 PractitionerRole
Other representations of profile: CSV, Excel, Schematron