Page Status: draft updated 2025-05-07
OrganizationAffiliation
Information domain hvo-agreement, where this resource is represented as Uppdrag
Page index
Introduction
The OrganizationAffiliation resource holds information about a recorded goal which an Organization has been assigned to execute during a longer (often not specified) time.
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 Profiles.
Overview
HVOOrganizationAffiliation (OrganizationAffiliation) | C | OrganizationAffiliation | |
id | S Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | C | 0..* | Extension |
modifierExtension | ?! C | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | Σ | 0..1 | boolean |
period | S Σ | 1..1 | Period |
id | 0..1 | string | |
extension | C | 0..* | Extension |
start | S Σ C | 1..1 | dateTime |
end | S Σ C | 0..1 | dateTime |
organization | S Σ | 1..1 | Reference(HVOOrganization) |
participatingOrganization | S Σ | 1..1 | Reference(HVOOrganization) |
network | Σ | 0..* | Reference(Organization) |
code | S Σ | 0..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | C | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
specialty | Σ | 0..* | CodeableConceptBinding |
location | Σ | 0..* | Reference(Location) |
healthcareService | S | 0..* | Reference(HVOService) |
telecom | S Σ C | 0..* | ContactPoint |
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ C | 1..1 | codeBinding |
value | S Σ C | 1..1 | string |
use | Σ ?! | 0..1 | codeBinding |
rank | Σ | 0..1 | positiveInt |
period | S Σ | 1..1 | Period |
id | 0..1 | string | |
extension | C | 0..* | Extension |
start | S Σ C | 1..1 | dateTime |
end | S Σ C | 0..1 | dateTime |
endpoint | 0..* | Reference(Endpoint) |
OrganizationAffiliation | |||
Short | 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. | ||
Cardinality | 0..* | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.id | |||
Short | 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Must Support | True | ||
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 | |||
Short | 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. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
Constraints |
| ||
OrganizationAffiliation.implicitRules | |||
Short | 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. | ||
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. | ||
Constraints |
| ||
OrganizationAffiliation.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language.
| ||
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). | ||
Constraints |
| ||
OrganizationAffiliation.text | |||
Short | Text summary of the resource, for human interpretation | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.contained | |||
Short | Contained, inline 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. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||
Mappings |
| ||
OrganizationAffiliation.extension | |||
Short | Additional content defined by implementations | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.identifier | |||
Short | Business identifiers that are specific to this role | ||
Definition | Business identifiers that are specific to this role. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Requirements | Often, specific identities are assigned for the agent. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.active | |||
Short | Whether this organization affiliation record is in active use | ||
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. | ||
Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.period | |||
Short | 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. | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.period.id | |||
Short | 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
OrganizationAffiliation.period.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.period.start | |||
Short | The moment when the affiliation becomes active | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.period.end | |||
Short | The moment when the affiliation becomes inactive or completed. Do not use if it is unknown | ||
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. | ||
Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.organization | |||
Short | Organization which ordered the task | ||
Definition | Organization where the role is available (primary organization/has members). | ||
Cardinality | 1..1 | ||
Type | Reference(HVOOrganization) | ||
Must Support | True | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.participatingOrganization | |||
Short | Organization which performs the task | ||
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 | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.network | |||
Short | 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). | ||
Cardinality | 0..* | ||
Type | Reference(Organization) | ||
Summary | True | ||
Constraints |
| ||
OrganizationAffiliation.code | |||
Short | Definition of the role the participatingOrganization plays | ||
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. | ||
Must Support | True | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.code.id | |||
Short | 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
OrganizationAffiliation.code.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.code.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 1..1 | ||
Type | Coding | ||
Must Support | True | ||
Summary | True | ||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.code.coding.id | |||
Short | 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
OrganizationAffiliation.code.coding.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.code.coding.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.code.coding.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.code.coding.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 1..1 | ||
Type | code | ||
Must Support | True | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.code.coding.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.code.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.code.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.specialty | |||
Short | Specific specialty of the participatingOrganization in the context of the role | ||
Definition | Specific specialty of the participatingOrganization in the context of the role. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | Specific specialty associated with the participating organization. | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.location | |||
Short | The location(s) at which the role occurs | ||
Definition | The location(s) at which the role occurs. | ||
Cardinality | 0..* | ||
Type | Reference(Location) | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.healthcareService | |||
Short | Healthcare services provided through the role | ||
Definition | Healthcare services provided through the role. | ||
Cardinality | 0..* | ||
Type | Reference(HVOService) | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom | |||
Short | Contact details at the participatingOrganization relevant to this Affiliation | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom.id | |||
Short | 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
OrganizationAffiliation.telecom.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom.system | |||
Short | phone | fax | email | pager | url | sms | other | ||
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. | ||
Must Support | True | ||
Summary | True | ||
Conditions | The cardinality or value of this element may be affected by these constraints: cpt-2 | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom.value | |||
Short | 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). | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom.use | |||
Short | home | work | temp | old | mobile - purpose of this contact point | ||
Definition | Identifies the purpose for the contact point. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Use of contact point. | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom.rank | |||
Short | 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. | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom.period | |||
Short | Time period when the contact point was/is in use | ||
Definition | Time period when the contact point was/is in use. | ||
Cardinality | 1..1 | ||
Type | Period | ||
Must Support | True | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom.period.id | |||
Short | 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
OrganizationAffiliation.telecom.period.extension | |||
Short | Additional content defined by implementations | ||
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) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom.period.start | |||
Short | Starting time with inclusive boundary | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.telecom.period.end | |||
Short | 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. | ||
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. | ||
Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
OrganizationAffiliation.endpoint | |||
Short | Technical endpoints providing access to services operated for this role | ||
Definition | Technical endpoints providing access to services operated for this role. | ||
Cardinality | 0..* | ||
Type | Reference(Endpoint) | ||
Constraints |
| ||
Mappings |
|
Details
Validation rules
Rule ID | Element | Description | Expression | Error | Severity |
---|---|---|---|---|---|
per-1 | period, telecom.period | If present, start SHALL have a lower value than end | start.hasValue().not() or end.hasValue().not() or (start <= end) |
Error | |
hvo-telecom-phone-1 | telecom | If telecom.system = #phone, value should follow format +46123456789 | value.matches('^\\+[1-9][0-9]+$') or system != 'phone' |
2-31-307: %s är ett ogiltigt format för telefonnummer | |
hvo-telecom-phone-2 | telecom | If telecom.system = #phone, value should have max length of 32 characters | value.length() <= 32 or system != 'phone' |
2-31-308: %s överskrider maxlängden för telefonnummer | |
hvo-telecom-url-1 | telecom | If telecom.system = #url, value should follow valid format. Example: https://example.com | value.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url' |
2-31-309: %s är ett ogiltigt format för URL | |
hvo-telecom-url-2 | telecom | If telecom.system = #url, value should have max length of 2000 characters | value.length() <= 2000 or system != 'url' |
2-31-310: %s överskrider maxlängden för URL | Error |
hvo-telecom-email-1 | telecom | If telecom.system = #email, value should follow valid format. Example: test@test.com | value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email' |
2-31-311: %s är ett ogiltigt format för e-postadress | |
hvo-telecom-email-2 | telecom | If telecom.system = #email, value should have max length of 255 characters | value.length() <= 255 or system != 'email' |
2-31-312: %s överskrider maxlängden för e-postadress | |
hvo-telecom-value-1 | telecom.value | A telecom value should have max length of 2000 characters | $this.length() <= 2000 |
2-31-313: %s överskrider maxlängden för elektronisk adress | Error |
Supported operations
HTTP methods
Operation | Supported | Comment |
---|---|---|
Search (GET, POST) | yes | Only using GET |
Insert (POST) | no | See Bundle - HVOContractTransactionBundle for creating HVOOrganizationAffiliations |
Update (PUT) | no | See Bundle - HVOContractTransactionBundle for updating HVOOrganizationAffiliations |
Delete (DEL) | no | |
Operation (GET, POST) | no |
Query operations
Supported Queries
GET .../OrganizationAffiliation?[parameters]
Parameter options
primary-organization=[Logical Id]
returns a Bundle of the HVOOrganizationAffiliations which have been assigned by the HVOOrganization with the supplied logical ID (UUID).participating-organization=[Logical Id]
returns a Bundle of the HVOOrganizationAffiliations which are gonna be performed by the HVOOrganization with the supplied logical ID (UUID).
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.
GET .../OrganizationAffiliation?[parameters]&[includes]
Include/reverse include options that can be chained using "&":
_revinclude=Contract:subject
includes the HVOContracts that cover the HVOOrganizationAffiliation_include=OrganizationAffiliation:primary-organization
includes the HVOOrganization which assigned the task of the HVOOrganizationAffiliation_include=OrganizationAffiliation:participating-organization
includes the HVOOrganization which has been assigned to execute the task of the HVOOrganizationAffiliation_include=OrganizationAffiliation:service
includes the HVOServices included in the HVOOrganizationAffiliation&_include:iterate=HealthcareService:organization
includes the HVOOrganizationalUnit which provides the HVOService
Search parameters
Parameter | Description | Comment |
---|---|---|
_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. |
participating-organization | The organization assigned to execute the task. | |
primary-organization | The organization that assigned the task. | This parameter corresponds to the HVOOrganizationAffiliation.organization field in the profile. |