- This is an Implementation Guide for UK Core FHIR Assets in Development.
- There will be disruption as the content will be updated on an ad-hoc basis and with links not working.
- Therefore this Implementation Guide must not be implemented.
- Please follow the guidance on the "Contact Us" page if you need any assistance.
StructureDefinition-UKCore-OrganizationAffiliation
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-OrganizationAffiliation | draft | 0.0.1 | 2023-12-12 | This profile defines the UK constraints and extensions on the International FHIR resource OrganizationAffiliation. |
Profile_Purpose |
---|
The purpose of this profile is to hold information about relationships between different organizations. |
Detailed Descriptions
OrganizationAffiliation | |
Definition | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
OrganizationAffiliation.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | System.String |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
OrganizationAffiliation.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
OrganizationAffiliation.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. CommonLanguages (preferred) |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
OrganizationAffiliation.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
OrganizationAffiliation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
OrganizationAffiliation.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
OrganizationAffiliation.identifier | |
Definition | Business identifiers that are specific to this role. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Often, specific identities are assigned for the agent. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.active | |
Definition | Whether this organization affiliation record is in active use. |
Cardinality | 0...1 |
Type | boolean |
Must Support | True |
Summary | True |
Requirements | Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use. |
Comments | If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.period | |
Definition | The period during which the participatingOrganization is affiliated with the primary organization. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | An affiliation may be created ahead of time and only be active for a defined period of time. Once the affiliation is complete, the fact that it existed may still be required. |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.organization | |
Definition | Organization where the role is available (primary organization/has members). |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.participatingOrganization | |
Definition | The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of). |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.network | |
Definition | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). |
Cardinality | 0...* |
Type | Reference(Organization) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.code | |
Definition | Definition of the role the participatingOrganization plays in the association. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The role the participating organization providing services to the primary organization. OrganizationAffiliationRole (example) |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.specialty | |
Definition | Specific specialty of the participatingOrganization in the context of the role. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Specific specialty associated with the participating organization. UKCorePracticeSettingCode (extensible) |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.location | |
Definition | The location(s) at which the role occurs. |
Cardinality | 0...* |
Type | Reference(Location) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.healthcareService | |
Definition | Healthcare services provided through the role. |
Cardinality | 0...* |
Type | Reference(HealthcareService) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.telecom | |
Definition | Contact details at the participatingOrganization relevant to this Affiliation. |
Cardinality | 0...* |
Type | ContactPoint |
Summary | True |
Requirements | Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization. |
Invariants |
|
Mappings |
|
OrganizationAffiliation.endpoint | |
Definition | Technical endpoints providing access to services operated for this role. |
Cardinality | 0...* |
Type | Reference(Endpoint) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Table View
OrganizationAffiliation | .. | |
OrganizationAffiliation.active | .. | |
OrganizationAffiliation.organization | .. | |
OrganizationAffiliation.participatingOrganization | .. | |
OrganizationAffiliation.specialty | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-OrganizationAffiliation" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-OrganizationAffiliation" /> <version value="0.0.1" /> <name value="UKCoreOrganizationAffiliation" /> <title value="UK Core OrganizationAffiliation" /> <status value="draft" /> <date value="2023-12-12" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [OrganizationAffiliation](https://hl7.org/fhir/R4/OrganizationAffiliation.html)." /> <purpose value="The purpose of this profile is to hold information about relationships between different organizations." /> <copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="OrganizationAffiliation" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation" /> <derivation value="constraint" /> <differential> <element id="OrganizationAffiliation.active"> <path value="OrganizationAffiliation.active" /> <mustSupport value="true" /> </element> <element id="OrganizationAffiliation.organization"> <path value="OrganizationAffiliation.organization" /> <mustSupport value="true" /> </element> <element id="OrganizationAffiliation.participatingOrganization"> <path value="OrganizationAffiliation.participatingOrganization" /> <mustSupport value="true" /> </element> <element id="OrganizationAffiliation.specialty"> <path value="OrganizationAffiliation.specialty" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-OrganizationAffiliation", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OrganizationAffiliation", "version": "0.0.1", "name": "UKCoreOrganizationAffiliation", "title": "UK Core OrganizationAffiliation", "status": "draft", "date": "2023-12-12", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [OrganizationAffiliation](https://hl7.org/fhir/R4/OrganizationAffiliation.html).", "purpose": "The purpose of this profile is to hold information about relationships between different organizations.", "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "OrganizationAffiliation", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation", "derivation": "constraint", "differential": { "element": [ { "id": "OrganizationAffiliation.active", "path": "OrganizationAffiliation.active", "mustSupport": true }, { "id": "OrganizationAffiliation.organization", "path": "OrganizationAffiliation.organization", "mustSupport": true }, { "id": "OrganizationAffiliation.participatingOrganization", "path": "OrganizationAffiliation.participatingOrganization", "mustSupport": true }, { "id": "OrganizationAffiliation.specialty", "path": "OrganizationAffiliation.specialty", "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" } } ] } }
Usage
This Profile has the following derived profiles:This Profile is referenced in the following Extensions:
This Profile is referenced in the following Profiles:
Feedback
Click here to:Examples
n/aExample Usage Scenarios
The following are example usage scenarios for the UK Core Organization Affiliation profile:
- Query for a...
- Record or update a...