HL7 FHIR® Validated Healthcare Directory Implementation Guide STU 1

Validated Healthcare Directory, published by HL7 International - Patient Admistration Working Group. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. 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.

In the VHDir IG, individuals and organizations are represented as participants in a Network through the practitionerRole and organizationAffiliation resources, respectively.

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 Thu Aug 31 20:26:52 UTC 2017 as a active by HL7 International.

This profile builds on Organization


NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*Network
... 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 S0..*Reference(VhDir Location)Network coverage area
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... identifier S0..*IdentifierIdentifies this network across multiple systems
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S0..1code
.... type S0..1CodeableConcept
.... system S0..1uri
.... value S0..1string
.... period S0..1Period
.... assigner S0..1Reference(VhDir Organization)
... active S1..1booleanWhether the network's record is still in active use.
... type S0..*CodeableConceptType of network
Binding: VhDir Network Type Value Set (example)
... name S0..1stringName
... alias S0..*stringAlternate names by which the Network is known
... telecom S0..0
... address S0..*AddressAn address for the network
... partOf S1..1Reference(VhDir Organization | VhDir Organization Affiliation)Reference to organization that owns the network
... contact S0..*BackboneElementContact for the network for a certain purpose.
.... purpose S0..1CodeableConcept
.... name S0..1HumanName
..... use S0..1code
..... text S0..1string
..... family S1..1string
..... given S1..*string
..... prefix S0..*string
..... suffix S0..*string
..... period S0..1Period
.... telecom S0..*ContactPoint
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... system S1..1code
..... value S1..1string
..... use S0..1code
..... rank S0..1positiveInt
..... period S0..1Period
.... address S0..1Address
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the network

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*Network
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*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 SI0..*Reference(VhDir Location)Network coverage area
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
... usage-restriction SI0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifies this network across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status SI1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... 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(VhDir Organization)Organization that issued id (may be just text)
... active ?!SΣI1..1booleanWhether the network's record is still in active use.
... type SΣI0..*CodeableConceptType of network
Binding: VhDir Network Type Value Set (example)
... name SΣI0..1stringName
... alias SI0..*stringAlternate names by which the Network is known
... address SI0..*AddressAn address for the network
... partOf SΣI1..1Reference(VhDir Organization | VhDir Organization Affiliation)Reference to organization that owns the network
... contact SI0..*BackboneElementContact for the network for a certain purpose.
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose SI0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name SI0..1HumanNameA name associated with the contact
..... id 0..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 | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text SΣI0..1stringText representation of the full name
..... family SΣI1..1stringFamily name (often called 'Surname')
..... given SΣI1..*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ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣI0..1PeriodTime period when name was/is in use
.... telecom SI0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-availabletime SI0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... contactpoint-viaintermediary SI0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣI1..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
.... address SI0..1AddressVisiting or postal addresses for the contact
... endpoint SI0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the network

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*Network
... 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 S0..*Reference(VhDir Location)Network coverage area
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... identifier S0..*IdentifierIdentifies this network across multiple systems
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S0..1code
.... type S0..1CodeableConcept
.... system S0..1uri
.... value S0..1string
.... period S0..1Period
.... assigner S0..1Reference(VhDir Organization)
... active S1..1booleanWhether the network's record is still in active use.
... type S0..*CodeableConceptType of network
Binding: VhDir Network Type Value Set (example)
... name S0..1stringName
... alias S0..*stringAlternate names by which the Network is known
... telecom S0..0
... address S0..*AddressAn address for the network
... partOf S1..1Reference(VhDir Organization | VhDir Organization Affiliation)Reference to organization that owns the network
... contact S0..*BackboneElementContact for the network for a certain purpose.
.... purpose S0..1CodeableConcept
.... name S0..1HumanName
..... use S0..1code
..... text S0..1string
..... family S1..1string
..... given S1..*string
..... prefix S0..*string
..... suffix S0..*string
..... period S0..1Period
.... telecom S0..*ContactPoint
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... system S1..1code
..... value S1..1string
..... use S0..1code
..... rank S0..1positiveInt
..... period S0..1Period
.... address S0..1Address
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the network

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*Network
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*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 SI0..*Reference(VhDir Location)Network coverage area
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
... usage-restriction SI0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifies this network across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status SI1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... 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(VhDir Organization)Organization that issued id (may be just text)
... active ?!SΣI1..1booleanWhether the network's record is still in active use.
... type SΣI0..*CodeableConceptType of network
Binding: VhDir Network Type Value Set (example)
... name SΣI0..1stringName
... alias SI0..*stringAlternate names by which the Network is known
... address SI0..*AddressAn address for the network
... partOf SΣI1..1Reference(VhDir Organization | VhDir Organization Affiliation)Reference to organization that owns the network
... contact SI0..*BackboneElementContact for the network for a certain purpose.
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose SI0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name SI0..1HumanNameA name associated with the contact
..... id 0..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 | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text SΣI0..1stringText representation of the full name
..... family SΣI1..1stringFamily name (often called 'Surname')
..... given SΣI1..*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ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period SΣI0..1PeriodTime period when name was/is in use
.... telecom SI0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contactpoint-availabletime SI0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... contactpoint-viaintermediary SI0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣI1..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
.... address SI0..1AddressVisiting or postal addresses for the contact
... endpoint SI0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the network

doco Documentation for this format

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


Terminology Bindings

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

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?coverage-area=[id]

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

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

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

    Support: SHALL support search by the address parameter

    • including the modifiers: contains, exact

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

    Support: SHOULD support search by the address-city parameter

    • including the modifiers: exact

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

    Support: SHOULD support search by the address-country parameter

    • including the modifiers: exact

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

    Support: SHOULD support search by the address-postalcode parameter

    • including the modifiers: exact

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

    Support: SHOULD support search by the address-state parameter

    • including the modifiers: exact

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

    Support: SHALL support search by the 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?identifier=[code]

    Support: SHALL support search by the identifier parameter

    • including the modifiers: text, ofType

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

    Support: MAY support search by the identifier-assigner parameter

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

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

    Support: SHALL support search by the name parameter

    • including the modifiers: exact, contains

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

    Support: SHALL support search by the partof parameter

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