This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions
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 network resource when using this profile.
Background & Scope
As used in this implementation guide, “network” primarily refers to a healthcare provider insurance network (although the resource could potentially be used to describe other types of healthcare networks as well, such as a health information exchange 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.
We propose a new network resource that consists of descriptive information about a network, such as its name & aliases, identifiers, address, contact information, the period during which it exists, who it is owned by, coverage area, endpoints (e.g. for accessing information about the network), and a type (e.g. PPO, HMO, dental, vision)
Examples:
The following are example uses for the vhdir-network profile:
Mandatory Data Elements
No mandatory elements in the proposed network Resource. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Profile specific implementation guidance:
Extensions:
Terminology
TBD
The official URL for this profile is:
http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-network
Defines the properties of a Network (through extending an Organization resource) for use in a Validated Healthcare Directory
This profile builds on Organization.
This profile was published on Fri Sep 01 06:26:52 AEST 2017 as a draft by HL7 International.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | Network | |
id | SΣ | 0..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | SI | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | S | 0..1 | ?? http://hl7.org/fhir/StructureDefinition/11179-de-effective-period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period |
location-reference | 0..* | Reference(vhdir-location) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-reference | |
usage-restriction | 0..* | Reference(vhdir-restriction) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Identifies this network across multiple systems |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
identifier-status | 0..1 | code | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status" | |
valueCode | 0..1 | code | Status | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 0..* | CodeableConcept | Type Binding: OrganizationType (example) |
name | SΣI | 0..1 | string | Name |
alias | S | 0..* | string | Alternate names by which the Network is known |
address | SI | 0..* | Address | An address for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
geolocation | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 1..1 | Extension | Latitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
extension | 1..1 | Extension | Longitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/geolocation" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23","end":"2010-07-01"} |
partOf | SΣ | 0..1 | Reference(vhdir-organization), Reference(vhdir-organizationRole) | Reference to organization that owns the network |
contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
name | 0..1 | HumanName | A name associated with the contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
text | Σ | 0..1 | string | Text representation of the full name |
family | Σ | 1..1 | string | Family name (often called 'Surname') |
given | Σ | 1..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | Σ | 0..1 | Period | Time period when name was/is in use |
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
contactPoint-availableTime | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "daysOfWeek" | |
valueCode | 0..1 | code | Days of week | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "allDay" | |
valueBoolean | 0..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "availableStartTime" | |
valueTime | 0..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "availableEndTime" | |
valueTime | 0..1 | time | Available end time | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime" | |
contactPoint-viaIntermediary | 0..1 | Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary" | |
value[x] | 0..1 | Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location) | Via intermediary | |
system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | 0..1 | Address | Visiting or postal addresses for the contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
geolocation | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 1..1 | Extension | Latitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
extension | 1..1 | Extension | Longitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/geolocation" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23","end":"2010-07-01"} |
endpoint | 0..* | Reference(vhdir-endpoint) | Technical endpoints providing access to services operated for the organization | |
Documentation for this format |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | Network | |
id | SΣ | 0..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | SI | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | S | 0..1 | ?? http://hl7.org/fhir/StructureDefinition/11179-de-effective-period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/11179-de-effective-period |
location-reference | 0..* | Reference(vhdir-location) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-reference | |
usage-restriction | 0..* | Reference(vhdir-restriction) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Identifies this network across multiple systems |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
identifier-status | 0..1 | code | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status" | |
valueCode | 0..1 | code | Status | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 0..* | CodeableConcept | Type Binding: OrganizationType (example) |
name | SΣI | 0..1 | string | Name |
alias | S | 0..* | string | Alternate names by which the Network is known |
address | SI | 0..* | Address | An address for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
geolocation | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 1..1 | Extension | Latitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
extension | 1..1 | Extension | Longitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/geolocation" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23","end":"2010-07-01"} |
partOf | SΣ | 0..1 | Reference(vhdir-organization), Reference(vhdir-organizationRole) | Reference to organization that owns the network |
contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
name | 0..1 | HumanName | A name associated with the contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
text | Σ | 0..1 | string | Text representation of the full name |
family | Σ | 1..1 | string | Family name (often called 'Surname') |
given | Σ | 1..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | Σ | 0..1 | Period | Time period when name was/is in use |
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
contactPoint-availableTime | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "daysOfWeek" | |
valueCode | 0..1 | code | Days of week | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "allDay" | |
valueBoolean | 0..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "availableStartTime" | |
valueTime | 0..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "availableEndTime" | |
valueTime | 0..1 | time | Available end time | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime" | |
contactPoint-viaIntermediary | 0..1 | Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary" | |
value[x] | 0..1 | Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location) | Via intermediary | |
system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | 0..1 | Address | Visiting or postal addresses for the contact | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
geolocation | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/geolocation | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 1..1 | Extension | Latitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
extension | 1..1 | Extension | Longitude with WGS84 datum | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/geolocation" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
line | Σ | 0..* | string | Street 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..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23","end":"2010-07-01"} |
endpoint | 0..* | Reference(vhdir-endpoint) | Technical endpoints providing access to services operated for the organization | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.
TBD