DaVinci PDEX Plan Net STU Ballot

This page is part of the DaVinci PDEX Plan Net (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

OrganizationAffiliation

 

The official URL for this profile is: 

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

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.

This profile builds on OrganizationAffiliation.

This profile was published on Wed Oct 23 00:00:00 EDT 2019 as a draft by HL7 Financial Management WG.

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 22 elements

Structures

This structure refers to these other structures:

Mapping Source

This structure represents the following mapping definition:

plannet.OrganizationAffiliation maps to OrganizationAffiliation:
  PN_Identifier.IdentifierUse maps to identifier.use
  PN_Identifier.IdentifierSystem maps to identifier.system
  PN_Identifier.IdentifierValue maps to identifier.value
  PN_Identifier.IdentifierType maps to identifier.type
  PN_Identifier.IdentifierPeriod maps to identifier.period
  PN_Identifier.IdentifierAssigner maps to identifier.assigner
  PrimaryOrganization maps to organization
  ParticipatingOrganization maps to participatingOrganization
  OrganizationAffiliationNetwork maps to network
  OrganizationAffiliationLocation maps to location
  OrganizationAffiliationHealthcareService maps to healthcareService
  OrganizationAffiliationTelecom maps to telecom
  OrganizationAffiliationTelecom.ContactPoint.Purpose maps to telecom.use
  OrganizationAffiliationTelecom.ContactPoint.Type maps to telecom.system
  OrganizationAffiliationTelecom.ContactPoint.PriorityRank maps to telecom.rank
  OrganizationAffiliationTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period
  OrganizationAffiliationTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value
  OrganizationAffiliationActive maps to active
  OrganizationAffiliationPeriod maps to period
  OrganizationAffiliationSpecialty maps to specialty
  OrganizationAffiliationEndpoint maps to endpoint
  OrganizationAffiliationCode maps to code
  constrain active to 1..1
  constrain telecom.system to 1..1
  constrain telecom.value to 1..1
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation plannet-OrganizationAffiliation
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... active S1..1
... period S
... organization SReference(plannet-Organization)
... participatingOrganization SReference(plannet-Organization)
... network SReference(plannet-Network)
... code S
... specialty S
... location SReference(plannet-Location)
... healthcareService SReference(plannet-HealthcareService)
... telecom S
.... system S1..1
.... value S1..1
.... use S
.... rank S
.... period S
... endpoint SReference(plannet-Endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*plannet-OrganizationAffiliation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifiers that are specific to this role
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(plannet-Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this organization affiliation record is in active use
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(plannet-Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(plannet-Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(plannet-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..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliationRole (example)
... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred)
... location SΣ0..*Reference(plannet-Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(plannet-HealthcareService)Healthcare services provided through the role
... telecom SΣ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(plannet-Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 22 elements

Structures

This structure refers to these other structures:

Mapping Source

This structure represents the following mapping definition:

plannet.OrganizationAffiliation maps to OrganizationAffiliation:
  PN_Identifier.IdentifierUse maps to identifier.use
  PN_Identifier.IdentifierSystem maps to identifier.system
  PN_Identifier.IdentifierValue maps to identifier.value
  PN_Identifier.IdentifierType maps to identifier.type
  PN_Identifier.IdentifierPeriod maps to identifier.period
  PN_Identifier.IdentifierAssigner maps to identifier.assigner
  PrimaryOrganization maps to organization
  ParticipatingOrganization maps to participatingOrganization
  OrganizationAffiliationNetwork maps to network
  OrganizationAffiliationLocation maps to location
  OrganizationAffiliationHealthcareService maps to healthcareService
  OrganizationAffiliationTelecom maps to telecom
  OrganizationAffiliationTelecom.ContactPoint.Purpose maps to telecom.use
  OrganizationAffiliationTelecom.ContactPoint.Type maps to telecom.system
  OrganizationAffiliationTelecom.ContactPoint.PriorityRank maps to telecom.rank
  OrganizationAffiliationTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period
  OrganizationAffiliationTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value
  OrganizationAffiliationActive maps to active
  OrganizationAffiliationPeriod maps to period
  OrganizationAffiliationSpecialty maps to specialty
  OrganizationAffiliationEndpoint maps to endpoint
  OrganizationAffiliationCode maps to code
  constrain active to 1..1
  constrain telecom.system to 1..1
  constrain telecom.value to 1..1

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation plannet-OrganizationAffiliation
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... active S1..1
... period S
... organization SReference(plannet-Organization)
... participatingOrganization SReference(plannet-Organization)
... network SReference(plannet-Network)
... code S
... specialty S
... location SReference(plannet-Location)
... healthcareService SReference(plannet-HealthcareService)
... telecom S
.... system S1..1
.... value S1..1
.... use S
.... rank S
.... period S
... endpoint SReference(plannet-Endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*plannet-OrganizationAffiliation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifiers that are specific to this role
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(plannet-Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this organization affiliation record is in active use
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(plannet-Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(plannet-Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(plannet-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..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliationRole (example)
... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred)
... location SΣ0..*Reference(plannet-Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(plannet-HealthcareService)Healthcare services provided through the role
... telecom SΣ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(plannet-Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.languagepreferredCommonLanguages
Max Binding: AllLanguages
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
OrganizationAffiliation.specialtypreferredPracticeSettingCodeValueSet
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
OrganizationAffiliation.telecom.userequiredContactPointUse

 

Constraints

IdPathDetailsRequirements
dom-2OrganizationAffiliationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4OrganizationAffiliationIf 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-3OrganizationAffiliationIf 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-6OrganizationAffiliationA resource should have narrative for robust management
: text.div.exists()
dom-5OrganizationAffiliationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()