careMESH NPD
0.1.0 - ci-build
careMESH NPD
0.1.0 - ci-build
careMESH NPD - Local Development build (v0.1.0). See the Directory of published versions
| Official URL: http://fhir.caremesh.app/StructureDefinition/caremesh-OrganizationAffiliation | Version: 0.1.0 | |||
| Active as of 2023-12-07 | Computable Name: CaremeshOrganizationAffiliation | |||
A careMESH Organization Affiliation is currently only used for a legacy mechanism of handling insurance associations.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PlannetOrganizationAffiliation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  OrganizationAffiliation | 0..* | PlannetOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OrganizationAffiliation | C | 0..* | PlannetOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
  identifier | Σ | 0..* | Identifier | Business identifiers that are specific to this role |
 use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | 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. |
 value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| active | SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use Required Pattern: true |
| period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
 organization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization where the role is available |
| participatingOrganization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
| network | SΣ | 0..* | Reference(Plan-Net Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
| code | SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible) |
| specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: Specialties VS (required) |
| location | SΣ | 0..* | Reference(Plan-Net Location) | The location(s) at which the role occurs |
| healthcareService | S | 0..* | Reference(Plan-Net HealthcareService) | Healthcare services provided through the role |
| telecom | SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation |
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| endpoint | S | 0..* | Reference(Plan-Net Endpoint) | Technical endpoints providing access to services operated for this role |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| OrganizationAffiliation.identifier.use | required | IdentifierUse |
| OrganizationAffiliation.identifier.type | extensible | Identifier Type Codes |
| OrganizationAffiliation.code | extensible | OrganizationAffiliationRoleVS |
| OrganizationAffiliation.specialty | required | SpecialtiesVS |
| OrganizationAffiliation.telecom.system | required | ContactPointSystem |
| OrganizationAffiliation.telecom.use | required | ContactPointUse |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | OrganizationAffiliation | 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 | error | OrganizationAffiliation | 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 | error | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| organization-or-participatingOrganization | error | OrganizationAffiliation | PlannetOrganizationAffiliation.organization or PlannetOrganizationAffiliation.participatingOrganization : organization.exists() or participatingOrganization.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| OrganizationAffiliation | C | 0..* | PlannetOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | 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. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use Required Pattern: true | ||||
| period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
| organization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization where the role is available | ||||
| participatingOrganization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
| network | SΣ | 0..* | Reference(Plan-Net Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
| code | SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible) | ||||
| specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: Specialties VS (required) | ||||
| location | SΣ | 0..* | Reference(Plan-Net Location) | The location(s) at which the role occurs | ||||
| healthcareService | S | 0..* | Reference(Plan-Net HealthcareService) | Healthcare services provided through the role | ||||
| telecom | SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| endpoint | S | 0..* | Reference(Plan-Net Endpoint) | Technical endpoints providing access to services operated for this role | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| OrganizationAffiliation.meta.security | extensible | All Security Labels | ||||
| OrganizationAffiliation.meta.tag | example | CommonTags | ||||
| OrganizationAffiliation.language | preferred | CommonLanguages
| ||||
| OrganizationAffiliation.identifier.use | required | IdentifierUse | ||||
| OrganizationAffiliation.identifier.type | extensible | Identifier Type Codes | ||||
| OrganizationAffiliation.code | extensible | OrganizationAffiliationRoleVS | ||||
| OrganizationAffiliation.specialty | required | SpecialtiesVS | ||||
| OrganizationAffiliation.telecom.system | required | ContactPointSystem | ||||
| OrganizationAffiliation.telecom.use | required | ContactPointUse |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from PlannetOrganizationAffiliation
Differential View
This structure is derived from PlannetOrganizationAffiliation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OrganizationAffiliation | 0..* | PlannetOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OrganizationAffiliation | C | 0..* | PlannetOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business identifiers that are specific to this role |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | 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. |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| active | SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use Required Pattern: true |
| period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
| organization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization where the role is available |
| participatingOrganization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
| network | SΣ | 0..* | Reference(Plan-Net Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
| code | SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible) |
| specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: Specialties VS (required) |
| location | SΣ | 0..* | Reference(Plan-Net Location) | The location(s) at which the role occurs |
| healthcareService | S | 0..* | Reference(Plan-Net HealthcareService) | Healthcare services provided through the role |
| telecom | SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation |
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| endpoint | S | 0..* | Reference(Plan-Net Endpoint) | Technical endpoints providing access to services operated for this role |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| OrganizationAffiliation.identifier.use | required | IdentifierUse |
| OrganizationAffiliation.identifier.type | extensible | Identifier Type Codes |
| OrganizationAffiliation.code | extensible | OrganizationAffiliationRoleVS |
| OrganizationAffiliation.specialty | required | SpecialtiesVS |
| OrganizationAffiliation.telecom.system | required | ContactPointSystem |
| OrganizationAffiliation.telecom.use | required | ContactPointUse |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | OrganizationAffiliation | 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 | error | OrganizationAffiliation | 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 | error | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| organization-or-participatingOrganization | error | OrganizationAffiliation | PlannetOrganizationAffiliation.organization or PlannetOrganizationAffiliation.participatingOrganization : organization.exists() or participatingOrganization.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| OrganizationAffiliation | C | 0..* | PlannetOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | 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. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use Required Pattern: true | ||||
| period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
| organization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization where the role is available | ||||
| participatingOrganization | SΣ | 0..1 | Reference(Plan-Net Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
| network | SΣ | 0..* | Reference(Plan-Net Network) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
| code | SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible) | ||||
| specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: Specialties VS (required) | ||||
| location | SΣ | 0..* | Reference(Plan-Net Location) | The location(s) at which the role occurs | ||||
| healthcareService | S | 0..* | Reference(Plan-Net HealthcareService) | Healthcare services provided through the role | ||||
| telecom | SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| endpoint | S | 0..* | Reference(Plan-Net Endpoint) | Technical endpoints providing access to services operated for this role | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| OrganizationAffiliation.meta.security | extensible | All Security Labels | ||||
| OrganizationAffiliation.meta.tag | example | CommonTags | ||||
| OrganizationAffiliation.language | preferred | CommonLanguages
| ||||
| OrganizationAffiliation.identifier.use | required | IdentifierUse | ||||
| OrganizationAffiliation.identifier.type | extensible | Identifier Type Codes | ||||
| OrganizationAffiliation.code | extensible | OrganizationAffiliationRoleVS | ||||
| OrganizationAffiliation.specialty | required | SpecialtiesVS | ||||
| OrganizationAffiliation.telecom.system | required | ContactPointSystem | ||||
| OrganizationAffiliation.telecom.use | required | ContactPointUse |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from PlannetOrganizationAffiliation
Other representations of profile: CSV, Excel, Schematron