Please note:

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.

OrganizationAffiliation	I		OrganizationAffiliation	There are no (further) constraints on this element Element Id OrganizationAffiliation Short description Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship Definition Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship. Data Type OrganizationAffiliation Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-3: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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:Role
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id OrganizationAffiliation.identifier Short description Business identifiers that are specific to this role Definition Business identifiers that are specific to this role. Requirements Often, specific identities are assigned for the agent. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
active	S Σ	0..1	boolean	There are no (further) constraints on this element Element Id OrganizationAffiliation.active Short description Whether this organization affiliation record is in active use Definition Whether this organization affiliation record is in active use. 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. Meaning When Missing This resource is generally assumed to be active if no value is provided for the active element Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:.statusCode
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id OrganizationAffiliation.period Short description The period during which the participatingOrganization is affiliated with the primary organization Definition The period during which the participatingOrganization is affiliated with the primary organization. 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. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.done[x] rim:.performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
organization	S Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id OrganizationAffiliation.organization Short description Organization where the role is available Definition Organization where the role is available (primary organization/has members). 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. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.scoper
participatingOrganization	S Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id OrganizationAffiliation.participatingOrganization Short description Organization that provides/performs the role (e.g. providing services or is a member of) 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). 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. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.player
network	Σ I	0..*	Reference(Organization)	There are no (further) constraints on this element Element Id OrganizationAffiliation.network Short description Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) Definition Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). 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. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
code	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id OrganizationAffiliation.code Short description Definition of the role the participatingOrganization plays Definition Definition of the role the participatingOrganization plays in the association. 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. Data Type CodeableConcept Binding The role the participating organization providing services to the primary organization. OrganizationAffiliationRole (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.code
specialty	Σ	0..*	CodeableConceptBinding	Element Id OrganizationAffiliation.specialty Short description Specific specialty of the participatingOrganization in the context of the role Definition Specific specialty of the participatingOrganization in the context of the role. 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. Data Type CodeableConcept Binding Specific specialty associated with the participating organization. UKCorePracticeSettingCode (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.player.HealthCareProvider[@classCode = 'PROV'].code
location	Σ I	0..*	Reference(Location)	There are no (further) constraints on this element Element Id OrganizationAffiliation.location Short description The location(s) at which the role occurs Definition The location(s) at which the role occurs. 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. Data Type Reference(Location) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5:FiveWs.where[x] rim:.performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
healthcareService	I	0..*	Reference(HealthcareService)	There are no (further) constraints on this element Element Id OrganizationAffiliation.healthcareService Short description Healthcare services provided through the role Definition Healthcare services provided through the role. 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. Data Type Reference(HealthcareService) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.player.QualifiedEntity[@classCode = 'QUAL'].code
telecom	Σ I	0..*	ContactPoint	There are no (further) constraints on this element Element Id OrganizationAffiliation.telecom Short description Contact details at the participatingOrganization relevant to this Affiliation Definition Contact details at the participatingOrganization relevant to this Affiliation. Requirements Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint rim:.telecom
endpoint	I	0..*	Reference(Endpoint)	There are no (further) constraints on this element Element Id OrganizationAffiliation.endpoint Short description Technical endpoints providing access to services operated for this role Definition Technical endpoints providing access to services operated for this role. 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. Data Type Reference(Endpoint) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)

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	dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-3: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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()`
Mappings	rim:Entity. Role, or Act rim:Role
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a rim:N/A rim:Act.text?
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	rim:Entity. Role, or Act rim:N/A
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a w5:FiveWs.status rim:.statusCode
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)`
Mappings	rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.done[x] rim:.performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.scoper
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.player
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.code
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.player.HealthCareProvider[@classCode = 'PROV'].code
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5:FiveWs.where[x] rim:.performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.player.QualifiedEntity[@classCode = 'QUAL'].code
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()`
Mappings	rim:n/a v2:XTN rim:TEL servd:ContactPoint rim:.telecom
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	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)

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 &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); 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 &quot;AS IS&quot; 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&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; 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:

Report issue for UKCore-OrganizationAffiliation

Examples

n/a

Example Usage Scenarios

The following are example usage scenarios for the UK Core Organization Affiliation profile:

Query for a...

Record or update a...

Profile Specific Implementation Guidance: