Page Status: draft 2024-12-02

OrganizationAffiliation

Page index

Introduction
Overview
Details
Supported operations

Introduction

Regarding information about how the "must support"-property is used in the Swedish National Catalog of Organization, Offerings and Contracts, please refer to the page Resources.

Overview

HVOOrganizationAffiliation (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
id	Σ	0..1	string	There are no (further) constraints on this element Element id OrganizationAffiliation.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. 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. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id OrganizationAffiliation.meta Short description Metadata about the resource 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id OrganizationAffiliation.implicitRules Short description A set of rules under which this content was created 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. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id OrganizationAffiliation.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id OrganizationAffiliation.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. 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. Data type Narrative Constraints 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?
contained		0..*	Resource	There are no (further) constraints on this element Element id OrganizationAffiliation.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources 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. 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. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id OrganizationAffiliation.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id OrganizationAffiliation.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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). 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
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	Σ	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	S Σ I	1..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
id		0..1	string	There are no (further) constraints on this element Element id OrganizationAffiliation.period.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id OrganizationAffiliation.period.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
start	S Σ I	1..1	dateTime	There are no (further) constraints on this element Element id OrganizationAffiliation.period.start Short description Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive. Comments If the low element is missing, the meaning is that the low boundary is not known. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: DR.1 rim: ./low
end	S Σ I	0..1	dateTime	There are no (further) constraints on this element Element id OrganizationAffiliation.period.end Short description End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Comments The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. Meaning when missing If the end of the period is missing, it means that the period is ongoing Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: DR.2 rim: ./high
organization	S Σ I	1..1	Reference(HVOOrganization)	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(HVOOrganization) 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	1..1	Reference(HVOOrganization)	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(HVOOrganization) 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	S Σ	0..1	CodeableConceptBinding	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. hvo-organization-affiliation-business-category (required) 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	There are no (further) constraints on this element 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. PracticeSettingCodeValueSet (preferred) 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	S I	0..*	Reference(HVOService)	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(HVOService) 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	S Σ 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
id		0..1	string	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
system	S Σ I	1..1	codeBinding	Element id OrganizationAffiliation.telecom.system Short description phone \| fax \| email \| pager \| url \| sms \| other Definition Telecommunications form for contact point - what communications system is required to make use of the contact. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.3 rim: ./scheme servd: ./ContactPointType
value	S Σ	1..1	string	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.value Short description The actual contact point details Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.use Short description home \| work \| temp \| old \| mobile - purpose of this contact point Definition Identifies the purpose for the contact point. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: n/a
period	S Σ I	1..1	Period	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. 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"] v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
id		0..1	string	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.period.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.period.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
start	S Σ I	1..1	dateTime	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.period.start Short description Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive. Comments If the low element is missing, the meaning is that the low boundary is not known. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: DR.1 rim: ./low
end	S Σ I	0..1	dateTime	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom.period.end Short description End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Comments The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. Meaning when missing If the end of the period is missing, it means that the period is ongoing Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: DR.2 rim: ./high
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)

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	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
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	1...1
Type	Period
Must Support	True
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.period.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
OrganizationAffiliation.period.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. 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.period.start
Definition	The start of the period. The boundary is inclusive.
Cardinality	1...1
Type	dateTime
Must Support	True
Summary	True
Comments	If the low element is missing, the meaning is that the low boundary is not known.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: DR.1 rim: ./low
OrganizationAffiliation.period.end
Definition	The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Cardinality	0...1
Type	dateTime
Must Support	True
Summary	True
Comments	The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: DR.2 rim: ./high
OrganizationAffiliation.organization
Definition	Organization where the role is available (primary organization/has members).
Cardinality	1...1
Type	Reference(HVOOrganization)
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	1...1
Type	Reference(HVOOrganization)
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...1
Type	CodeableConcept
Binding	The role the participating organization providing services to the primary organization. hvo-organization-affiliation-business-category (required)
Must Support	True
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. PracticeSettingCodeValueSet (preferred)
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(HVOService)
Must Support	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.QualifiedEntity[@classCode = 'QUAL'].code
OrganizationAffiliation.telecom
Definition	Contact details at the participatingOrganization relevant to this Affiliation.
Cardinality	0...*
Type	ContactPoint
Must Support	True
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.telecom.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
OrganizationAffiliation.telecom.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. 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.telecom.system
Definition	Telecommunications form for contact point - what communications system is required to make use of the contact.
Cardinality	1...1
Type	code
Binding	Telecommunications form for contact point. ContactPointSystem (required)
Must Support	True
Summary	True
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XTN.3 rim: ./scheme servd: ./ContactPointType
OrganizationAffiliation.telecom.value
Definition	The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Cardinality	1...1
Type	string
Must Support	True
Summary	True
Requirements	Need to support legacy numbers that are not in a tightly controlled format.
Comments	Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
OrganizationAffiliation.telecom.use
Definition	Identifies the purpose for the contact point.
Cardinality	0...1
Type	code
Binding	Use of contact point. ContactPointUse (required)
Modifier	True
Summary	True
Requirements	Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments	Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
OrganizationAffiliation.telecom.rank
Definition	Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Cardinality	0...1
Type	positiveInt
Summary	True
Comments	Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: n/a
OrganizationAffiliation.telecom.period
Definition	Time period when the contact point was/is in use.
Cardinality	1...1
Type	Period
Must Support	True
Summary	True
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"] v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
OrganizationAffiliation.telecom.period.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
OrganizationAffiliation.telecom.period.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. 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.telecom.period.start
Definition	The start of the period. The boundary is inclusive.
Cardinality	1...1
Type	dateTime
Must Support	True
Summary	True
Comments	If the low element is missing, the meaning is that the low boundary is not known.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: DR.1 rim: ./low
OrganizationAffiliation.telecom.period.end
Definition	The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Cardinality	0...1
Type	dateTime
Must Support	True
Summary	True
Comments	The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: DR.2 rim: ./high
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)

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="HVOOrganizationAffiliation" />
    <url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" />
    <version value="0.1.0" />
    <name value="HVOOrganizationAffiliation" />
    <title value="OrganizationAffiliation" />
    <status value="draft" />
    <description value="HVOOrganizationAffiliation contains information about an assignment which someone has been assigned to perform during a longer (often undecided) period of time." />
    <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.period">
            <path value="OrganizationAffiliation.period" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.period.start">
            <path value="OrganizationAffiliation.period.start" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.period.end">
            <path value="OrganizationAffiliation.period.end" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.organization">
            <path value="OrganizationAffiliation.organization" />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.participatingOrganization">
            <path value="OrganizationAffiliation.participatingOrganization" />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.code">
            <path value="OrganizationAffiliation.code" />
            <max value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://electronichealth.se/fhir/hvo/ValueSet/hvo-organization-affiliation-business-category" />
            </binding>
        </element>
        <element id="OrganizationAffiliation.healthcareService">
            <path value="OrganizationAffiliation.healthcareService" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOService" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.telecom">
            <path value="OrganizationAffiliation.telecom" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.telecom.system">
            <path value="OrganizationAffiliation.telecom.system" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-system" />
            </binding>
        </element>
        <element id="OrganizationAffiliation.telecom.value">
            <path value="OrganizationAffiliation.telecom.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.telecom.period">
            <path value="OrganizationAffiliation.telecom.period" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.telecom.period.start">
            <path value="OrganizationAffiliation.telecom.period.start" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.telecom.period.end">
            <path value="OrganizationAffiliation.telecom.period.end" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "HVOOrganizationAffiliation",
    "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation",
    "version": "0.1.0",
    "name": "HVOOrganizationAffiliation",
    "title": "OrganizationAffiliation",
    "status": "draft",
    "description": "HVOOrganizationAffiliation contains information about an assignment which someone has been assigned to perform during a longer (often undecided) period of time.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "OrganizationAffiliation",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "OrganizationAffiliation.period",
                "path": "OrganizationAffiliation.period",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.period.start",
                "path": "OrganizationAffiliation.period.start",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.period.end",
                "path": "OrganizationAffiliation.period.end",
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.organization",
                "path": "OrganizationAffiliation.organization",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.participatingOrganization",
                "path": "OrganizationAffiliation.participatingOrganization",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.code",
                "path": "OrganizationAffiliation.code",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://electronichealth.se/fhir/hvo/ValueSet/hvo-organization-affiliation-business-category"
                }
            },
            {
                "id": "OrganizationAffiliation.healthcareService",
                "path": "OrganizationAffiliation.healthcareService",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOService"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.telecom",
                "path": "OrganizationAffiliation.telecom",
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.telecom.system",
                "path": "OrganizationAffiliation.telecom.system",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system"
                }
            },
            {
                "id": "OrganizationAffiliation.telecom.value",
                "path": "OrganizationAffiliation.telecom.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.telecom.period",
                "path": "OrganizationAffiliation.telecom.period",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.telecom.period.start",
                "path": "OrganizationAffiliation.telecom.period.start",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.telecom.period.end",
                "path": "OrganizationAffiliation.telecom.period.end",
                "mustSupport": true
            }
        ]
    }
}

Details

Supported operations

HTTP methods

Operation	Supported	Comment
Search (GET, POST)	yes	Kommentar
Insert (POST)	yes/no	Kommentar
Update (PUT)	yes/no	Kommentar
Delete (DEL)	yes/no	Kommentar
Operation (GET, POST)	yes/no	Kommentar

Query operations

Supported Queries

.../OrganizationAffiliation/[id]
../OrganizationAffiliation?primary-organization=[Logical Id]

Include & reverse includes

Supported usage of include and revinclude. This kind of search returns a bundle of both the base resource and the related resources specified in the parameter.

.../OrganizationAffiliation?[parameters]&_include=OrganizationAffiliation:healthcareService&_include:iterate=HealthcareService:providedBy returns OrganizationAffiliation and related HVOServices as well as the HVOOrganizationalUnits which provide the Services.
.../OrganizationAffiliation?[parameters]&_include=OrganizationAffiliation:organization returns OrganizationAffiliation and related HVOOrganizations
.../OrganizationAffiliation?[parameters]&_revinclude=Contract:subject returns OrganizationAffiliation and the related Contracts

Search parameters

Parameter	Description	Comment
OrganizationAffiliation/[LogicalId]	A read based on the logical ID (UUID) of an OrganizationAffiliation.
primary-organization	The organization that receives the services from the participating organization.
_include	Subject resource to include in the response.	See HL7 Include other resources for more information.
_revinclude	Related resources of the specified type to include in the response.	See HL7 Include other resources for more information.

Other operations

Operation name	HTTP verbs	Comment
$namn	Verb	Kommentar