DaVinci PDEX Plan Net
0.3.0 - STU1

DaVinci PDEX Plan Net, published by HL7 Financial Management Working Group. This is not an authorized publication; it is the continuous build for version 0.3.0). This version is based on the current content of https://github.com/HL7/davinci-pdex-plan-net/ and changes regularly. See the Directory of published versions

Resource Profile: PlannetOrganizationAffiliation

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.

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation

Implementation Guidance

There is currently no implementation guidance.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from OrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: PlannetOrganizationAffiliation.organization or PlannetOrganizationAffiliation.participatingOrganization
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Extension
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification
.... id S0..1stringUnique id for inter-element referencing
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(Organization)Organization that issued id (may be just text)
... active S0..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period S0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization S0..1Reference(Plan-net Organization)Organization where the role is available
... participatingOrganization S0..1Reference(Plan-net Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network S0..*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 S0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty S0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties (required)
... location S0..*Reference(Plan-net Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(Plan-net HealthcareService)Healthcare services provided through the role
... telecom S0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
.... period S0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(Plan-net Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: PlannetOrganizationAffiliation.organization or PlannetOrganizationAffiliation.participatingOrganization
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId ΣI0..1idVersion specific identifier
.... lastUpdated ΣI1..1instantWhen the resource version last changed
.... source ΣI0..1uriIdentifies where the resource comes from
.... profile ΣI0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣI0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag ΣI0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification I0..*(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness identifiers that are specific to this role
.... id S0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI0..1stringThe value that is unique
Example General: 123456
.... period SΣI0..1PeriodTime period when id is/was valid for use
.... assigner SΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣI0..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period SΣI0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣI0..1Reference(Plan-net Organization)Organization where the role is available
... participatingOrganization SΣI0..1Reference(Plan-net Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣI0..*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ΣI0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty SΣI0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties (required)
... location SΣI0..*Reference(Plan-net Location)The location(s) at which the role occurs
... healthcareService SI0..*Reference(Plan-net HealthcareService)Healthcare services provided through the role
... telecom SΣI0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣI0..1stringThe actual contact point details
.... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣI0..1PeriodTime period when the contact point was/is in use
... endpoint SI0..*Reference(Plan-net Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: PlannetOrganizationAffiliation.organization or PlannetOrganizationAffiliation.participatingOrganization
... identifier ΣI0..*IdentifierBusiness identifiers that are specific to this role
.... id 0..1stringUnique id for inter-element referencing
.... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system ΣI0..1uriThe namespace for the identifier value
.... value ΣI0..1stringThe value that is unique
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ΣI0..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period ΣI0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... participatingOrganization ΣI0..1Reference(Plan-net Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network ΣI0..*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 ΣI0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty ΣI0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties (required)
... location ΣI0..*Reference(Plan-net Location)The location(s) at which the role occurs
... healthcareService I0..*Reference(Plan-net HealthcareService)Healthcare services provided through the role
... telecom ΣI0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value ΣI0..1stringThe actual contact point details
.... use ?!ΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... endpoint I0..*Reference(Plan-net Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Differential View

This structure is derived from OrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: PlannetOrganizationAffiliation.organization or PlannetOrganizationAffiliation.participatingOrganization
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Extension
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification
.... id S0..1stringUnique id for inter-element referencing
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(Organization)Organization that issued id (may be just text)
... active S0..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period S0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization S0..1Reference(Plan-net Organization)Organization where the role is available
... participatingOrganization S0..1Reference(Plan-net Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network S0..*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 S0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty S0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties (required)
... location S0..*Reference(Plan-net Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(Plan-net HealthcareService)Healthcare services provided through the role
... telecom S0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
.... period S0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(Plan-net Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: PlannetOrganizationAffiliation.organization or PlannetOrganizationAffiliation.participatingOrganization
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId ΣI0..1idVersion specific identifier
.... lastUpdated ΣI1..1instantWhen the resource version last changed
.... source ΣI0..1uriIdentifies where the resource comes from
.... profile ΣI0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣI0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag ΣI0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification I0..*(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness identifiers that are specific to this role
.... id S0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI0..1stringThe value that is unique
Example General: 123456
.... period SΣI0..1PeriodTime period when id is/was valid for use
.... assigner SΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣI0..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period SΣI0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣI0..1Reference(Plan-net Organization)Organization where the role is available
... participatingOrganization SΣI0..1Reference(Plan-net Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣI0..*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ΣI0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty SΣI0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties (required)
... location SΣI0..*Reference(Plan-net Location)The location(s) at which the role occurs
... healthcareService SI0..*Reference(Plan-net HealthcareService)Healthcare services provided through the role
... telecom SΣI0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣI0..1stringThe actual contact point details
.... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣI0..1PeriodTime period when the contact point was/is in use
... endpoint SI0..*Reference(Plan-net Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.meta.securityextensibleAll Security Labels
OrganizationAffiliation.meta.tagexampleCommonTags
OrganizationAffiliation.languagepreferredCommonLanguages
Max Binding: AllLanguages
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
OrganizationAffiliation.specialtyrequiredSpecialtiesVS
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
OrganizationAffiliation.telecom.userequiredContactPointUse

Constraints

IdPathDetailsRequirements
organization-or-participatingOrganizationOrganizationAffiliationPlannetOrganizationAffiliation.organization or PlannetOrganizationAffiliation.participatingOrganization
: organization.exists() or participatingOrganization.exists()