HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - STU1
HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - STU1
HL7 FHIR Implementation Guide: Rwanda HIV, published by Jembi Health Systems. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/openhie/Rwanda-HIV and changes regularly. See the Directory of published versions
| Official URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/implementing-partner | Version: 0.1.0 | |||
| Active as of 2023-09-15 | Computable Name: ImplementingPartnerOrganization | |||
Implementing partner organization.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | 0..* | Organization | A grouping of people or organizations with a common purpose | |
  Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 ImplementingPartnerOrganizationIndex | 1..1 | integer | Implementing Partner Organization URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/implementing-partner-index | |
  Slices for identifier | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | |
  identifier:OrgID | 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 | |
 display | 0..1 | string | Representation defined by the system Required Pattern: Organization identifier | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Implementing Partner Organization identifier | |
 system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/organization-id | |
 value | S | 0..1 | string | The value that is unique |
| name | 1..1 | string | Name used for the organization | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ImplementingPartnerOrganizationIndex | 1..1 | integer | Implementing Partner Organization URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/implementing-partner-index | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
| identifier:OrgID | Σ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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/organization-id |
| value | SΣC | 0..1 | string | The value that is unique Example General: 123456 |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| name | ΣC | 1..1 | string | Name used for the organization |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.identifier:OrgID.use | required | IdentifierUse |
| 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 |
| 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 | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ImplementingPartnerOrganizationIndex | 1..1 | integer | Implementing Partner Organization URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/implementing-partner-index | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
| identifier:OrgID | Σ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 Required Pattern: Organization identifier |
| 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: Implementing Partner Organization identifier |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/organization-id |
| value | SΣC | 0..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 | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. |
| 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 |
| 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: (unbound) (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 | ||||
| Path | Conformance | ValueSet |
| Organization.language | required | AllLanguages |
| Organization.identifier:OrgID.use | required | IdentifierUse |
| Organization.identifier:OrgID.type | extensible | IdentifierTypeCodes |
| Organization.type | example | OrganizationType |
| Organization.qualification.code | example |
| 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: 4 elements (1 nested mandatory element)
Must-Support: 1 element
Fixed Value: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | 0..* | Organization | A grouping of people or organizations with a common purpose | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ImplementingPartnerOrganizationIndex | 1..1 | integer | Implementing Partner Organization URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/implementing-partner-index | |
| Slices for identifier | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | |
| identifier:OrgID | 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 | |
| display | 0..1 | string | Representation defined by the system Required Pattern: Organization identifier | |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Implementing Partner Organization identifier | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/organization-id | |
| value | S | 0..1 | string | The value that is unique |
| name | 1..1 | string | Name used for the organization | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ImplementingPartnerOrganizationIndex | 1..1 | integer | Implementing Partner Organization URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/implementing-partner-index | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
| identifier:OrgID | Σ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 Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/organization-id |
| value | SΣC | 0..1 | string | The value that is unique Example General: 123456 |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| name | ΣC | 1..1 | string | Name used for the organization |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.identifier:OrgID.use | required | IdentifierUse |
| 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 |
| 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 | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ImplementingPartnerOrganizationIndex | 1..1 | integer | Implementing Partner Organization URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/implementing-partner-index | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
| identifier:OrgID | Σ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 Required Pattern: Organization identifier |
| 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: Implementing Partner Organization identifier |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/organization-id |
| value | SΣC | 0..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 | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. |
| 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 |
| 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: (unbound) (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 | ||||
| Path | Conformance | ValueSet |
| Organization.language | required | AllLanguages |
| Organization.identifier:OrgID.use | required | IdentifierUse |
| Organization.identifier:OrgID.type | extensible | IdentifierTypeCodes |
| Organization.type | example | OrganizationType |
| Organization.qualification.code | example |
| 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: 4 elements (1 nested mandatory element)
Must-Support: 1 element
Fixed Value: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Jembi Health Systems. Package openhie.fhir.rwanda.hiv#0.1.0 based on FHIR 5.0.0. Generated 2023-09-15
Links: Table of Contents |
QA Report |
Version History |
|