Page Status: draft updated 2025-05-07

OrganizationAffiliation

Informationsmodell_2025-05-07_avtal 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

idS Σ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
identifierΣ0..*Identifier
activeΣ0..1boolean
id0..1string
extensionC0..*Extension
startS Σ C1..1dateTime
endS Σ C0..1dateTime
organizationS Σ1..1Reference(HVOOrganization)
participatingOrganizationS Σ1..1Reference(HVOOrganization)
networkΣ0..*Reference(Organization)
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
specialtyΣ0..*CodeableConceptBinding
locationΣ0..*Reference(Location)
healthcareServiceS0..*Reference(HVOService)
id0..1string
extensionC0..*Extension
systemS Σ C1..1codeBinding
valueS Σ C1..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
id0..1string
extensionC0..*Extension
startS Σ C1..1dateTime
endS Σ C0..1dateTime
endpoint0..*Reference(Endpoint)
OrganizationAffiliation
ShortDefines 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.

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: Role
OrganizationAffiliation.id
ShortLogical 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.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
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
ShortMetadata 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.

Cardinality0..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
OrganizationAffiliation.implicitRules
ShortA 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.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
OrganizationAffiliation.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
OrganizationAffiliation.text
ShortText 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.

Cardinality0..1
TypeNarrative
Aliasnarrative, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
OrganizationAffiliation.contained
ShortContained, 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.

Cardinality0..*
TypeResource
Aliasinline 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: N/A
OrganizationAffiliation.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • 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
OrganizationAffiliation.modifierExtension
ShortExtensions 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).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, 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
  • 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
OrganizationAffiliation.identifier
ShortBusiness identifiers that are specific to this role
Definition

Business identifiers that are specific to this role.

Cardinality0..*
TypeIdentifier
SummaryTrue
Requirements

Often, specific identities are assigned for the agent.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • rim: .id
OrganizationAffiliation.active
ShortWhether this organization affiliation record is in active use
Definition

Whether this organization affiliation record is in active use.

Cardinality0..1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: .statusCode
OrganizationAffiliation.period
ShortThe period during which the participatingOrganization is affiliated with the primary organization
Definition

The period during which the participatingOrganization is affiliated with the primary organization.

Cardinality1..1
TypePeriod
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.done[x]
  • rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
OrganizationAffiliation.period.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
OrganizationAffiliation.period.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • 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
OrganizationAffiliation.period.start
ShortThe moment when the affiliation becomes active
Definition

The start of the period. The boundary is inclusive.

Cardinality1..1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

If the low element is missing, the meaning is that the low boundary is not known.

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.1
  • rim: ./low
  • OrganizationAffiliationToHVOUppdragLogical: giltigFrom
OrganizationAffiliation.period.end
ShortThe 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.

Cardinality0..1
TypedateTime
Must SupportTrue
SummaryTrue
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

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.2
  • rim: ./high
  • OrganizationAffiliationToHVOUppdragLogical: giltigTom
OrganizationAffiliation.organization
ShortOrganization which ordered the task
Definition

Organization where the role is available (primary organization/has members).

Cardinality1..1
TypeReference(HVOOrganization)
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .scoper
  • OrganizationAffiliationToHVOUppdragLogical: harBestallare(HVOOrganisationLogical)
OrganizationAffiliation.participatingOrganization
ShortOrganization 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).

Cardinality1..1
TypeReference(HVOOrganization)
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .player
  • OrganizationAffiliationToHVOUppdragLogical: harUtforare(HVOOrganisationLogical)
OrganizationAffiliation.network
ShortHealth 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).

Cardinality0..*
TypeReference(Organization)
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
OrganizationAffiliation.code
ShortDefinition of the role the participatingOrganization plays
Definition

Definition of the role the participatingOrganization plays in the association.

Cardinality0..*
TypeCodeableConcept
Binding

The role the participating organization providing services to the primary organization.

hvo-organization-affiliation-business-category (required)

Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .code
  • OrganizationAffiliationToHVOUppdragLogical: typ
OrganizationAffiliation.code.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
OrganizationAffiliation.code.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • 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
OrganizationAffiliation.code.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality1..1
TypeCoding
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
OrganizationAffiliation.code.coding.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
OrganizationAffiliation.code.coding.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • 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
OrganizationAffiliation.code.coding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
OrganizationAffiliation.code.coding.version
ShortVersion 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.

Cardinality0..1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
OrganizationAffiliation.code.coding.code
ShortSymbol 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).

Cardinality1..1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
OrganizationAffiliation.code.coding.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
OrganizationAffiliation.code.coding.userSelected
ShortIf 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).

Cardinality0..1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
OrganizationAffiliation.code.text
ShortPlain 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.

Cardinality0..1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
OrganizationAffiliation.specialty
ShortSpecific specialty of the participatingOrganization in the context of the role
Definition

Specific specialty of the participatingOrganization in the context of the role.

Cardinality0..*
TypeCodeableConcept
Binding

Specific specialty associated with the participating organization.

PracticeSettingCodeValueSet (preferred)

SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .player.HealthCareProvider[@classCode = 'PROV'].code
OrganizationAffiliation.location
ShortThe location(s) at which the role occurs
Definition

The location(s) at which the role occurs.

Cardinality0..*
TypeReference(Location)
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.where[x]
  • rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
OrganizationAffiliation.healthcareService
ShortHealthcare services provided through the role
Definition

Healthcare services provided through the role.

Cardinality0..*
TypeReference(HVOService)
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .player.QualifiedEntity[@classCode = 'QUAL'].code
  • OrganizationAffiliationToHVOUppdragLogical: omfattar(HVOTjanstLogical)
OrganizationAffiliation.telecom
ShortContact details at the participatingOrganization relevant to this Affiliation
Definition

Contact details at the participatingOrganization relevant to this Affiliation.

Cardinality0..*
TypeContactPoint
Must SupportTrue
SummaryTrue
Requirements

Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • hvo-telecom-phone-2: If telecom.system = #phone, value should have max length of 32 characters
    value.length() <= 32 or system != 'phone'
  • hvo-telecom-email-2: If telecom.system = #email, value should have max length of 255 characters
    value.length() <= 255 or system != 'email'
  • hvo-telecom-url-1: If telecom.system = #url, value should follow valid format. Example: https://example.com
    value.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url'
  • hvo-telecom-url-2: If telecom.system = #url, value should have max length of 2000 characters
    value.length() <= 2000 or system != 'url'
  • hvo-telecom-email-1: 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'
  • hvo-telecom-phone-1: If telecom.system = #phone, value should follow format +46123456789
    value.matches('^\\+[1-9][0-9]+$') or system != 'phone'
Mappings
  • rim: .telecom
  • OrganizationAffiliationToHVOUppdragLogical: har(HVOTelekommunikationLogical)
OrganizationAffiliation.telecom.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
OrganizationAffiliation.telecom.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • 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
OrganizationAffiliation.telecom.system
Shortphone | fax | email | pager | url | sms | other
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Cardinality1..1
Typecode
Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Must SupportTrue
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
OrganizationAffiliation.telecom.value
ShortThe 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).

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • hvo-telecom-value-1: A telecom value should have max length of 2000 characters
    $this.length() <= 2000
Mappings
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
OrganizationAffiliation.telecom.use
Shorthome | work | temp | old | mobile - purpose of this contact point
Definition

Identifies the purpose for the contact point.

Cardinality0..1
Typecode
Binding

Use of contact point.

ContactPointUse (required)

ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XTN.2 - but often indicated by field
  • rim: unique(./use)
  • servd: ./ContactPointPurpose
OrganizationAffiliation.telecom.rank
ShortSpecify 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.

Cardinality0..1
TypepositiveInt
SummaryTrue
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: n/a
  • rim: n/a
OrganizationAffiliation.telecom.period
ShortTime period when the contact point was/is in use
Definition

Time period when the contact point was/is in use.

Cardinality1..1
TypePeriod
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
OrganizationAffiliation.telecom.period.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
OrganizationAffiliation.telecom.period.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • 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
OrganizationAffiliation.telecom.period.start
ShortStarting time with inclusive boundary
Definition

The start of the period. The boundary is inclusive.

Cardinality1..1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

If the low element is missing, the meaning is that the low boundary is not known.

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.1
  • rim: ./low
OrganizationAffiliation.telecom.period.end
ShortEnd 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.

Cardinality0..1
TypedateTime
Must SupportTrue
SummaryTrue
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

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.2
  • rim: ./high
OrganizationAffiliation.endpoint
ShortTechnical endpoints providing access to services operated for this role
Definition

Technical endpoints providing access to services operated for this role.

Cardinality0..*
TypeReference(Endpoint)
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
<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" />
<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" />
<identity value="OrganizationAffiliationToHVOUppdragLogical" />
<uri value="HVOUppdragLogical" />
</mapping>
<kind value="resource" />
<abstract value="false" />
<type value="OrganizationAffiliation" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation" />
<derivation value="constraint" />
<element id="OrganizationAffiliation.id">
<path value="OrganizationAffiliation.id" />
<mustSupport value="true" />
</element>
<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" />
<short value="The moment when the affiliation becomes active" />
<min value="1" />
<mustSupport value="true" />
<identity value="OrganizationAffiliationToHVOUppdragLogical" />
<map value="giltigFrom" />
</mapping>
</element>
<element id="OrganizationAffiliation.period.end">
<path value="OrganizationAffiliation.period.end" />
<short value="The moment when the affiliation becomes inactive or completed. Do not use if it is unknown" />
<mustSupport value="true" />
<identity value="OrganizationAffiliationToHVOUppdragLogical" />
<map value="giltigTom" />
</mapping>
</element>
<element id="OrganizationAffiliation.organization">
<path value="OrganizationAffiliation.organization" />
<short value="Organization which ordered the task" />
<min value="1" />
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
</type>
<mustSupport value="true" />
<identity value="OrganizationAffiliationToHVOUppdragLogical" />
<map value="harBestallare(HVOOrganisationLogical)" />
</mapping>
</element>
<element id="OrganizationAffiliation.participatingOrganization">
<path value="OrganizationAffiliation.participatingOrganization" />
<short value="Organization which performs the task" />
<min value="1" />
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
</type>
<mustSupport value="true" />
<identity value="OrganizationAffiliationToHVOUppdragLogical" />
<map value="harUtforare(HVOOrganisationLogical)" />
</mapping>
</element>
<element id="OrganizationAffiliation.code">
<path value="OrganizationAffiliation.code" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://electronichealth.se/hvo/ValueSet/hvo-organization-affiliation-business-category" />
</binding>
<identity value="OrganizationAffiliationToHVOUppdragLogical" />
<map value="typ" />
</mapping>
</element>
<element id="OrganizationAffiliation.code.coding">
<path value="OrganizationAffiliation.code.coding" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="OrganizationAffiliation.code.coding.system">
<path value="OrganizationAffiliation.code.coding.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="OrganizationAffiliation.code.coding.code">
<path value="OrganizationAffiliation.code.coding.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="OrganizationAffiliation.healthcareService">
<path value="OrganizationAffiliation.healthcareService" />
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOService" />
</type>
<mustSupport value="true" />
<identity value="OrganizationAffiliationToHVOUppdragLogical" />
<map value="omfattar(HVOTjanstLogical)" />
</mapping>
</element>
<element id="OrganizationAffiliation.telecom">
<path value="OrganizationAffiliation.telecom" />
<key value="hvo-telecom-phone-2" />
<severity value="warning" />
<human value="If telecom.system = #phone, value should have max length of 32 characters" />
<expression value="value.length() <= 32 or system != 'phone'" />
<source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" />
</constraint>
<key value="hvo-telecom-email-2" />
<severity value="warning" />
<human value="If telecom.system = #email, value should have max length of 255 characters" />
<expression value="value.length() <= 255 or system != 'email'" />
<source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" />
</constraint>
<key value="hvo-telecom-url-1" />
<severity value="warning" />
<human value="If telecom.system = #url, value should follow valid format. Example: https://example.com" />
<expression value="value.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url'" />
<source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" />
</constraint>
<key value="hvo-telecom-url-2" />
<severity value="warning" />
<human value="If telecom.system = #url, value should have max length of 2000 characters" />
<expression value="value.length() <= 2000 or system != 'url'" />
<source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" />
</constraint>
<key value="hvo-telecom-email-1" />
<severity value="warning" />
<human value="If telecom.system = #email, value should follow valid format Example: test@test.com" />
<expression value="value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email'" />
<source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" />
</constraint>
<key value="hvo-telecom-phone-1" />
<severity value="warning" />
<human value="If telecom.system = #phone, value should follow format +46123456789" />
<expression value="value.matches('^\\+[1-9][0-9]+$') or system != 'phone'" />
<source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" />
</constraint>
<mustSupport value="true" />
<identity value="OrganizationAffiliationToHVOUppdragLogical" />
<map value="har(HVOTelekommunikationLogical)" />
</mapping>
</element>
<element id="OrganizationAffiliation.telecom.system">
<path value="OrganizationAffiliation.telecom.system" />
<min value="1" />
<mustSupport value="true" />
<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" />
<key value="hvo-telecom-value-1" />
<severity value="warning" />
<human value="A telecom value should have max length of 2000 characters" />
<expression value="$this.length() <= 2000" />
<source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation" />
</constraint>
<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",
"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",
"mapping": [
{
"identity": "OrganizationAffiliationToHVOUppdragLogical",
"uri": "HVOUppdragLogical"
}
],
"kind": "resource",
"abstract": false,
"type": "OrganizationAffiliation",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation",
"derivation": "constraint",
"element": [
{
"id": "OrganizationAffiliation.id",
"path": "OrganizationAffiliation.id",
"mustSupport": true
},
{
"id": "OrganizationAffiliation.period",
"path": "OrganizationAffiliation.period",
"min": 1,
"mustSupport": true
},
{
"id": "OrganizationAffiliation.period.start",
"path": "OrganizationAffiliation.period.start",
"short": "The moment when the affiliation becomes active",
"min": 1,
"mustSupport": true,
"mapping": [
{
"identity": "OrganizationAffiliationToHVOUppdragLogical",
"map": "giltigFrom"
}
]
},
{
"id": "OrganizationAffiliation.period.end",
"path": "OrganizationAffiliation.period.end",
"short": "The moment when the affiliation becomes inactive or completed. Do not use if it is unknown",
"mustSupport": true,
"mapping": [
{
"identity": "OrganizationAffiliationToHVOUppdragLogical",
"map": "giltigTom"
}
]
},
{
"id": "OrganizationAffiliation.organization",
"path": "OrganizationAffiliation.organization",
"short": "Organization which ordered the task",
"min": 1,
"type": [
{
"code": "Reference",
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization"
]
}
],
"mustSupport": true,
"mapping": [
{
"identity": "OrganizationAffiliationToHVOUppdragLogical",
"map": "harBestallare(HVOOrganisationLogical)"
}
]
},
{
"id": "OrganizationAffiliation.participatingOrganization",
"path": "OrganizationAffiliation.participatingOrganization",
"short": "Organization which performs the task",
"min": 1,
"type": [
{
"code": "Reference",
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization"
]
}
],
"mustSupport": true,
"mapping": [
{
"identity": "OrganizationAffiliationToHVOUppdragLogical",
"map": "harUtforare(HVOOrganisationLogical)"
}
]
},
{
"id": "OrganizationAffiliation.code",
"path": "OrganizationAffiliation.code",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/hvo/ValueSet/hvo-organization-affiliation-business-category"
},
"mapping": [
{
"identity": "OrganizationAffiliationToHVOUppdragLogical",
"map": "typ"
}
]
},
{
"id": "OrganizationAffiliation.code.coding",
"path": "OrganizationAffiliation.code.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "OrganizationAffiliation.code.coding.system",
"path": "OrganizationAffiliation.code.coding.system",
"min": 1,
"mustSupport": true
},
{
"id": "OrganizationAffiliation.code.coding.code",
"path": "OrganizationAffiliation.code.coding.code",
"min": 1,
"mustSupport": true
},
{
"id": "OrganizationAffiliation.healthcareService",
"path": "OrganizationAffiliation.healthcareService",
"type": [
{
"code": "Reference",
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOService"
]
}
],
"mustSupport": true,
"mapping": [
{
"identity": "OrganizationAffiliationToHVOUppdragLogical",
"map": "omfattar(HVOTjanstLogical)"
}
]
},
{
"id": "OrganizationAffiliation.telecom",
"path": "OrganizationAffiliation.telecom",
{
"key": "hvo-telecom-phone-2",
"human": "If telecom.system = #phone, value should have max length of 32 characters",
"source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation",
"severity": "warning",
"expression": "value.length() <= 32 or system != 'phone'"
},
{
"key": "hvo-telecom-email-2",
"human": "If telecom.system = #email, value should have max length of 255 characters",
"source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation",
"severity": "warning",
"expression": "value.length() <= 255 or system != 'email'"
},
{
"key": "hvo-telecom-url-1",
"human": "If telecom.system = #url, value should follow valid format. Example: https://example.com",
"source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation",
"severity": "warning",
"expression": "value.matches('(https?|ftp)://(-\\\\.)?([^\\\\s/?\\\\.#-]+\\\\.?)+(/[^\\\\s]*)?$') or system != 'url'"
},
{
"key": "hvo-telecom-url-2",
"human": "If telecom.system = #url, value should have max length of 2000 characters",
"source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation",
"severity": "warning",
"expression": "value.length() <= 2000 or system != 'url'"
},
{
"key": "hvo-telecom-email-1",
"human": "If telecom.system = #email, value should follow valid format Example: test@test.com",
"source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation",
"severity": "warning",
"expression": "value.matches('^[\\\\w.-]{1,64}@(?!.{254})[\\\\w.-]+\\\\.[A-Za-z]{2,4}$') or system != 'email'"
},
{
"key": "hvo-telecom-phone-1",
"human": "If telecom.system = #phone, value should follow format +46123456789",
"source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation",
"severity": "warning",
"expression": "value.matches('^\\\\+[1-9][0-9]+$') or system != 'phone'"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "OrganizationAffiliationToHVOUppdragLogical",
"map": "har(HVOTelekommunikationLogical)"
}
]
},
{
"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,
{
"key": "hvo-telecom-value-1",
"human": "A telecom value should have max length of 2000 characters",
"source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAffiliation",
"severity": "warning",
"expression": "$this.length() <= 2000"
}
],
"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

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

  1. GET .../OrganizationAffiliation?[parameters]

Parameter options

  1. primary-organization=[Logical Id] returns a Bundle of the HVOOrganizationAffiliations which have been assigned by the HVOOrganization with the supplied logical ID (UUID).
  2. 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.

  1. 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.