This page is part of the Validated Healthcare Directory FHIR IG (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organizationaffiliation | Version: 1.0.0 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: VhdirOrganizationAffiliation | ||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
Details about the role a participating organization plays in relation to a primary organization
This profile sets minimum expectations for searching for and fetching information associated with an organization role. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the OrganizationAffiliation resource when using this profile.
Background & Scope
The OrganizationAffiliation resource describes relationships between two or more organizations, including the services one organization provides another, the location(s) where they provide services, the availability of those services, electronic endpoints, and other relevant information.
OrganizationAffiliation addresses the need to define a non-hierarchical relationship between two or more organizations. For example:
OrganizationAffiliation is similar in structure to practitionerRole. Instead of references to practitioner and organization (as in practitionerRole), organizationaffiliation includes references to a participatingOrg and an organization. The participating organization provides "services" to the primary organization (much like a practitioner provides services to an organization). Using the three examples above:
OrganizationAffiliation is also used to indicate when an organization provides services for a health insurance provider network.
–
This profile modifies the base OrganizationAffiliation resource in the following manner:
Constrains the cardinality of OrganizationAffiliation.active
(1..1), OrganizationAffiliation.telecom.system
(1..1), and OrganizationAffiliation.telecom.value
(1..1)
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
Adds extensions:
Examples:
The following are example uses for the vhdir-organizationaffiliation profile:
Mandatory Data Elements
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each OrganizationAffiliation must have:
OrganizationAffiliation.active
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | OrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business identifiers that are specific to this role ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization where the role is available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | The location(s) at which the role occurs ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | Healthcare services provided through the role ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for this role ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
OrganizationAffiliation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
OrganizationAffiliation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
OrganizationAffiliation.code | example | OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role from the FHIR Standard | |
OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
OrganizationAffiliation.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
OrganizationAffiliation.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
This structure is derived from OrganizationAffiliation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | OrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() |
S | 0..* | Identifier | Business identifiers that are specific to this role |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 1..1 | boolean | Whether this organization affiliation record is in active use |
![]() ![]() ![]() |
S | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization where the role is available |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Location) | The location(s) at which the role occurs |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | Healthcare services provided through the role |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for this role |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | OrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization where the role is available | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization. | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | The location(s) at which the role occurs | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | Healthcare services provided through the role | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for this role | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
OrganizationAffiliation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
OrganizationAffiliation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
OrganizationAffiliation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
OrganizationAffiliation.code | example | OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role from the FHIR Standard | ||||
OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
OrganizationAffiliation.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
OrganizationAffiliation.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
This structure is derived from OrganizationAffiliation
Summary
Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 27 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | OrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business identifiers that are specific to this role ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization where the role is available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | The location(s) at which the role occurs ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | Healthcare services provided through the role ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for this role ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
OrganizationAffiliation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
OrganizationAffiliation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
OrganizationAffiliation.code | example | OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role from the FHIR Standard | |
OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
OrganizationAffiliation.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
OrganizationAffiliation.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
Differential View
This structure is derived from OrganizationAffiliation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | OrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() |
S | 0..* | Identifier | Business identifiers that are specific to this role |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 1..1 | boolean | Whether this organization affiliation record is in active use |
![]() ![]() ![]() |
S | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization where the role is available |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Location) | The location(s) at which the role occurs |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | Healthcare services provided through the role |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for this role |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | OrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization where the role is available | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization. | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | The location(s) at which the role occurs | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | Healthcare services provided through the role | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for this role | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
OrganizationAffiliation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
OrganizationAffiliation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
OrganizationAffiliation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
OrganizationAffiliation.code | example | OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role from the FHIR Standard | ||||
OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
OrganizationAffiliation.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
OrganizationAffiliation.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
This structure is derived from OrganizationAffiliation
Summary
Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 27 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
GET [base]/OrganizationAffiliation?active=[code]
Support: SHALL support search by the active
parameter: http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-active
GET [base]/OrganizationAffiliation?endpoint=[id]
Support: SHOULD support search by the endpoint
parameter
Endpoint
endpoint.identifier
, endpoint.connection-type
, endpoint.organization
GET [base]/OrganizationAffiliation?identifier=[code]
Support: SHALL support search by the identifier
parameter
text
, ofType
GET [base]/Organization?identifier-assigner=[id]
Support: MAY support search by the identifier-assigner
parameter
Organization
below
identifier-assigner.identifier
, identifier-assigner.name
GET [base]/OrganizationAffiliation?location=[id]
Support: SHALL support search by the location
parameter
Location
above
, below
location.identifier
, location.type
, location.address
, location.organization
GET [base]/OrganizationAffiliation?network=[id]
Support: SHOULD support search by the network
parameter
Organization
network.identifier
, network.name
, network.partof
GET [base]/OrganizationAffiliation?participating-organization=[id]
Support: SHALL support search by the participating-organization
parameter
Organization
above
, below
participating-organization.identifier
, participating-organization.name
, participating-organization.address
, participating-organization.partof
, participating-organization.type
GET [base]/OrganizationAffiliation?primary-organization=[id]
Support: SHALL support search by the primary-organization
parameter
Organization
above
, below
primary-organization.identifier
, primary-organization.type
, primary-organization.address
, primary-organization.name
, primary-organization.partof
GET [base]/OrganizationAffiliation?role=[code]
Support: SHALL support search by the role
parameter
text
GET [base]/OrganizationAffiliation?service=[id]
Support: SHOULD support search by the service
parameter
HealthcareService
service.identifier
, service.service-category
, service.organization
, service.location
GET [base]/OrganizationAffiliation?specialty=[code]
Support: SHOULD support search by the specialty
parameter
text
GET [base]/Organization?via-intermediary=[id]
Support: MAY support search by the via-intermediary
parameter
PractitionerRole
, Organization
, OrganizationAffiliation
, Location