VhDir Implementation Guide CI Build: STU2 Ballot

This page is part of the Validated Healthcare Directory FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

StructureDefinition-vhdir-network

This profile sets minimum expectations for searching for and fetching information associated with a healthcare provider insurance network. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the Organization resource when using this profile.

Background & Scope

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.

Network is a profile on the Organization resource. This profile modifies the base Organization resource in the following manner:

  • Constrains the cardinality of organization.active (1..1), organization.telecom (0..0), organization.partOf (1..1), organization.contact.name.family (1..1), organization.contact.name.given (1..*), organization.contact.telecom.system (1..1), and organization.contact.telecom.value (1..1)

  • All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile

  • Adds extensions:

  1. Identifier status (1..1) - indicates the status of an organization’s identifier
  2. Via intermediary (0..1) - a reference to an alternative point of contact for this organization
  3. Available time (0..*) - indicates when an organization is available for contact
  4. Period (0..1) - Represents a time period for the network
  5. Coverage area (0..*) - Indicates a coverage area for the network
  6. Restriction (0..*) - indicates whether disclosure of any data associated with a network is restricted

Examples:

The following are example uses for the vhdir-network 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 network must have:

  1. A coded value in organization.active
  2. A reference to an organization or organizationaffiliation resource indicating the owner of the network in organization.partOf

Profile specific implementation guidance:

  • PractitionerRole and OrganizationAffiliation are used to indicate a Practitioner and Organization’s participation in a Network, respectively

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-network

Published on Fri Sep 01 06:26:52 AEST 2017 as a active by HL7 International.

This profile builds on Organization

Complete Summary of the Mandatory Requirements

  1. A coded value in organization.active
  2. A reference to an organization or organizationaffiliation resource indicating the owner of the network in organization.partOf
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*Network
... id S0..1id
... meta S0..1Meta
... text S0..1Narrative
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... organization-period S0..1PeriodValid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... location-reference 0..*Reference(VhDir Location)Location
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
... usage-restriction 0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... identifier 0..*IdentifierIdentifies this network across multiple systems
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... identifier-status 1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
.... assigner 0..1Reference(VhDir Organization)
... active 1..1boolean
... type 0..*CodeableConceptType
Binding: VhDir Network Type Value Set (example)
... name S0..1stringName
... alias S0..*stringAlternate names by which the Network is known
... telecom 0..0
... address S0..*Address
... partOf S1..1Reference(VhDir Organization | VhDir OrganizationAffiliation)Reference to organization that owns the network
... contact 0..*BackboneElement
.... name 0..1HumanName
..... family 1..1string
..... given 1..*string
.... telecom 0..*ContactPoint
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... contactpoint-availabletime 0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... system 1..1code
..... value 1..1string
... endpoint 0..*Reference(VhDir Endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*Network
... id SΣ0..1idLogical id of this artifact
... meta SΣ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: Common Languages (preferred)
... text S0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... organization-period SI0..1PeriodValid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... location-reference 0..*Reference(VhDir Location)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
... usage-restriction 0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this network across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status 1..1codeExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
..... valueCode 1..1codeactive|inactive|issued in error|revoked|pending
Binding: VhDir Identifier Status Value Set (example)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active ?!Σ1..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptType
Binding: VhDir Network Type Value Set (example)
... name SΣI0..1stringName
... alias S0..*stringAlternate names by which the Network is known
... address SI0..*AddressAn address for the organization
... partOf SΣ1..1Reference(VhDir Organization | VhDir OrganizationAffiliation)Reference to organization that owns the network
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ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 Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-availabletime 0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... extension 0..*ExtensionDays of week
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"daysOfWeek"
....... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
...... extension 0..1ExtensionAll day
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"allDay"
....... valueBoolean 1..1booleanAll day
...... extension 0..1ExtensionAvailable start time
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableStartTime"
....... valueTime 1..1timeAvailable start time
...... extension 0..1ExtensionAvailable end time
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableEndTime"
....... valueTime 1..1timeAvailable end time
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
...... valueReference 1..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Via intermediary
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*Network
... id S0..1id
... meta S0..1Meta
... text S0..1Narrative
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... organization-period S0..1PeriodValid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... location-reference 0..*Reference(VhDir Location)Location
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
... usage-restriction 0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... identifier 0..*IdentifierIdentifies this network across multiple systems
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... identifier-status 1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
.... assigner 0..1Reference(VhDir Organization)
... active 1..1boolean
... type 0..*CodeableConceptType
Binding: VhDir Network Type Value Set (example)
... name S0..1stringName
... alias S0..*stringAlternate names by which the Network is known
... telecom 0..0
... address S0..*Address
... partOf S1..1Reference(VhDir Organization | VhDir OrganizationAffiliation)Reference to organization that owns the network
... contact 0..*BackboneElement
.... name 0..1HumanName
..... family 1..1string
..... given 1..*string
.... telecom 0..*ContactPoint
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... contactpoint-availabletime 0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... system 1..1code
..... value 1..1string
... endpoint 0..*Reference(VhDir Endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*Network
... id SΣ0..1idLogical id of this artifact
... meta SΣ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: Common Languages (preferred)
... text S0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... organization-period SI0..1PeriodValid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... location-reference 0..*Reference(VhDir Location)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
... usage-restriction 0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this network across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status 1..1codeExtension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
..... valueCode 1..1codeactive|inactive|issued in error|revoked|pending
Binding: VhDir Identifier Status Value Set (example)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active ?!Σ1..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptType
Binding: VhDir Network Type Value Set (example)
... name SΣI0..1stringName
... alias S0..*stringAlternate names by which the Network is known
... address SI0..*AddressAn address for the organization
... partOf SΣ1..1Reference(VhDir Organization | VhDir OrganizationAffiliation)Reference to organization that owns the network
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ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 Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-availabletime 0..*(Complex)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... extension 0..*ExtensionDays of week
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"daysOfWeek"
....... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
...... extension 0..1ExtensionAll day
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"allDay"
....... valueBoolean 1..1booleanAll day
...... extension 0..1ExtensionAvailable start time
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableStartTime"
....... valueTime 1..1timeAvailable start time
...... extension 0..1ExtensionAvailable end time
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1"availableEndTime"
....... valueTime 1..1timeAvailable end time
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Extension
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
...... valueReference 1..1Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location)Via intermediary
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

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


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

Supported Searches

  1. GET [base]/Organization?active=[code]

    Support: SHALL support search by the active parameter: http://hl7.org/fhir/SearchParameter/Organization-active

  1. GET [base]/Organization?address-use=[code]

    Support: MAY support search by the address-use parameter: http://hl7.org/fhir/SearchParameter/Organization-address-use

  1. GET [base]/Organization?network-coverage-area=[id]

    Support: SHOULD support search by the network-coverage-area parameter

    • with a target type: Location
    • including these search paramaters which may be chained: location-identifier, location-contains

  1. GET [base]/Organization?organization-address=[string]

    Support: SHALL support search by the organization-address parameter

    • including the modifiers: contains, exact

  1. GET [base]/Organization?organiztion-address-city=[string]

    Support: SHOULD support search by the organization-address-city parameter

    • including the modifiers: exact

  1. GET [base]/Organization?organization-address-country=[string]

    Support: SHOULD support search by the organization-address-country parameter

    • including the modifiers: exact

  1. GET [base]/Organization?organization-address-postalcode=[string]

    Support: SHOULD support search by the organization-address-postalcode parameter

    • including the modifiers: exact

  1. GET [base]/Organization?organization-address-state=[string]

    Support: SHOULD support search by the organization-address-state parameter

    • including the modifiers: exact

  1. GET [base]/Organization?organization-endpoint=[id]

    Support: SHALL support search by the organization-endpoint parameter

    • with a target type: Endpoint
    • including these search paramaters which may be chained: endpoint-identifier, endpoint-connection-type, endpoint-organization

  1. GET [base]/Organization?organization-identifier=[code]

    Support: SHALL support search by the organization-identifier parameter

    • including the modifiers: text, ofType

  1. GET [base]/Organization?organization-identifier-assigner=[id]

    Support: MAY support search by the organization-identifier-assigner parameter

    • with a target type: Organization
    • including the modifiers: below
    • including these search paramaters which may be chained: organization-identifier, organization-name

  1. GET [base]/Organization?organization-name=[string]

    Support: SHALL support search by the organization-name parameter

    • including the modifiers: exact, contains

  1. GET [base]/Organization?organization-partof=[id]

    Support: SHALL support search by the organization-partof parameter

    • with a target type: Organization
    • including the modifiers: above, below
    • including these search paramaters which may be chained: organization-identifier, organization-name, organization-address, organization-type