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

Network

 

The official URL for this profile is: 

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

A Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. A network is typically owned by a payer.

In the PlanNet IG, individuals and organizations are represented as participants in a PLan-Net Network through the practitionerRole and Plan-Net-organizationAffiliation resources, respectively.

This profile builds on Organization.

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 (7 nested mandatory elements)
Must-Support: 27 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

plannet.Network maps to Organization:
  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
  NetworkActive maps to active
  NetworkType maps to type
  NetworkAddress maps to address
  NetworkName maps to name
  NetworkAlias maps to alias
  LocationReference maps to extension
  PartOf maps to partOf
  NetworkEndpoint maps to endpoint
  NetworkContact maps to contact
  NetworkContact.HumanName.Purpose maps to contact.name.use
  NetworkContact.HumanName.Name maps to contact.name.text
  NetworkContact.HumanName.FamilyName maps to contact.name.family
  NetworkContact.HumanName.GivenName maps to contact.name.given
  NetworkContact.HumanName.Prefix maps to contact.name.prefix
  NetworkContact.HumanName.Suffix maps to contact.name.suffix
  NetworkContact.HumanName.EffectiveTimePeriod maps to contact.name.period
  NetworkContact.ContactPoint.TelecomNumberOrAddress maps to contact.telecom.value
  NetworkContact.ContactPoint.Purpose maps to contact.telecom.use
  NetworkContact.ContactPoint.PriorityRank maps to contact.telecom.rank
  NetworkContact.ContactPoint.EffectiveTimePeriod maps to contact.telecom.period
  NetworkContact.ContactPoint.Type maps to contact.telecom.system
  constrain contact.name to 1..1
  constrain contact.name.family to 1..1
  constrain contact.name.given to 1..*
  constrain contact.telecom.system to 1..1
  constrain contact.telecom.value to 1..1
  constrain telecom to 0..0
  constrain partOf to 1..1
  constrain address.line to 0..4
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization plannet-Network
... extension Slice: Unordered, Open by value:url
... plannet-LocationReference-extension S0..*Reference(plannet-Location)LocationReference
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-LocationReference-extension
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... active S1..1
... type S
... name S
... alias S
... telecom 0..0
... address S0..1
.... line 0..4
... partOf S1..1Reference(plannet-Organization)
... contact S
.... name 1..1
..... use S
..... text S
..... family S1..1
..... given S1..*
..... prefix S
..... suffix S
..... period S
.... telecom
..... system S1..1
..... value S1..1
..... use S
..... rank S
..... period S
... endpoint SReference(plannet-Endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*plannet-Network
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... 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
Slice: Unordered, Open by value:url
... plannet-LocationReference-extension S0..*Reference(plannet-Location)LocationReference
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-LocationReference-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
.... 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 the organization's record is still in active use
... type SΣ0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI0..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... address SI0..1AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..4stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... partOf SΣ1..1Reference(plannet-Organization)The organization of which this organization forms a part
... contact SI0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 1..1HumanNameA name associated with the contact
..... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text SΣ0..1stringText representation of the full name
..... family SΣ1..1stringFamily name (often called 'Surname')
..... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣ0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... 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
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(plannet-Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Summary

Mandatory: 0 element (7 nested mandatory elements)
Must-Support: 27 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

plannet.Network maps to Organization:
  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
  NetworkActive maps to active
  NetworkType maps to type
  NetworkAddress maps to address
  NetworkName maps to name
  NetworkAlias maps to alias
  LocationReference maps to extension
  PartOf maps to partOf
  NetworkEndpoint maps to endpoint
  NetworkContact maps to contact
  NetworkContact.HumanName.Purpose maps to contact.name.use
  NetworkContact.HumanName.Name maps to contact.name.text
  NetworkContact.HumanName.FamilyName maps to contact.name.family
  NetworkContact.HumanName.GivenName maps to contact.name.given
  NetworkContact.HumanName.Prefix maps to contact.name.prefix
  NetworkContact.HumanName.Suffix maps to contact.name.suffix
  NetworkContact.HumanName.EffectiveTimePeriod maps to contact.name.period
  NetworkContact.ContactPoint.TelecomNumberOrAddress maps to contact.telecom.value
  NetworkContact.ContactPoint.Purpose maps to contact.telecom.use
  NetworkContact.ContactPoint.PriorityRank maps to contact.telecom.rank
  NetworkContact.ContactPoint.EffectiveTimePeriod maps to contact.telecom.period
  NetworkContact.ContactPoint.Type maps to contact.telecom.system
  constrain contact.name to 1..1
  constrain contact.name.family to 1..1
  constrain contact.name.given to 1..*
  constrain contact.telecom.system to 1..1
  constrain contact.telecom.value to 1..1
  constrain telecom to 0..0
  constrain partOf to 1..1
  constrain address.line to 0..4

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization plannet-Network
... extension Slice: Unordered, Open by value:url
... plannet-LocationReference-extension S0..*Reference(plannet-Location)LocationReference
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-LocationReference-extension
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... active S1..1
... type S
... name S
... alias S
... telecom 0..0
... address S0..1
.... line 0..4
... partOf S1..1Reference(plannet-Organization)
... contact S
.... name 1..1
..... use S
..... text S
..... family S1..1
..... given S1..*
..... prefix S
..... suffix S
..... period S
.... telecom
..... 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
.. Organization I0..*plannet-Network
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... 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
Slice: Unordered, Open by value:url
... plannet-LocationReference-extension S0..*Reference(plannet-Location)LocationReference
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-LocationReference-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
.... 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 the organization's record is still in active use
... type SΣ0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI0..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... address SI0..1AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..4stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... partOf SΣ1..1Reference(plannet-Organization)The organization of which this organization forms a part
... contact SI0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 1..1HumanNameA name associated with the contact
..... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text SΣ0..1stringText representation of the full name
..... family SΣ1..1stringFamily name (often called 'Surname')
..... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣ0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... 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
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(plannet-Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

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

 

Terminology Bindings

PathConformanceValueSet
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse

 

Constraints

IdPathDetailsRequirements
dom-2OrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4OrganizationIf 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-3OrganizationIf 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-6OrganizationA resource should have narrative for robust management
: text.div.exists()
dom-5OrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
org-1OrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2Organization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())