Validated Healthcare Directory
0.2.0 - CI Build

Validated Healthcare Directory, published by HL7 International - Patient Administration Work 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

Resource Profile: VhDir Network

Defining URL:http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-network
Version:0.2.0
Name:VhdirNetwork
Title:VhDir Network
Status:Active as of 2017-09-01 06:26:52+1000
Definition:

Defines the properties of a Network (through extending an Organization resource) for use in a Validated Healthcare Directory

Publisher:HL7 International - Patient Administration Work Group
Copyright:

HL7 International

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/vhdir/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, Snapshots and how the different presentations work.

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationNetwork
... Slices for extension 0..*ExtensionExtension
Slice: 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
.... Slices for extension 0..*ExtensionExtension
Slice: 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..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... 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)Reference to organization that owns the network
... contact S0..*BackboneElementContact for the network for a certain purpose.
.... purpose S0..1CodeableConceptThe type of contact
.... name S0..1HumanNameA name associated with the contact
..... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
..... text S0..1stringText representation of the full name
..... family S1..1stringFamily name (often called 'Surname')
..... given S1..*stringGiven names (not always 'first'). Includes middle names
..... prefix S0..*stringParts that come before the name
..... suffix S0..*stringParts that come after the name
..... period S0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... Slices for extension 0..*ExtensionExtension
Slice: 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..1codephone | fax | email | pager | url | sms | other
..... value S1..1stringThe actual contact point details
..... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
..... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
..... period S0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
... 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..*OrganizationNetwork
... id Σ0..1stringLogical 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: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: 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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifies this network across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: 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 ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... 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(VhDir Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the network's record is still in active use.
... type SΣ0..*CodeableConceptType of network
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 network
... partOf SΣ1..1Reference(VhDir Organization)Reference to organization that owns the network
... contact S0..*BackboneElementContact for the network 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 S0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for 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): The use of a human name.

..... 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 S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: 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 SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period SΣ0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
... 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..*OrganizationNetwork
... organization-period 0..1PeriodValid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... location-reference 0..*Reference(VhDir Location)Network coverage area
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 ΣI0..*IdentifierIdentifies this network across multiple systems
.... identifier-status 1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
.... value Σ0..1stringThe value that is unique
.... 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 network's record is still in active use.
... type Σ0..*CodeableConceptType of network
Binding: VhDir Network Type Value Set (example)
... name ΣI0..1stringName
... alias 0..*stringAlternate names by which the Network is known
... address I0..*AddressAn address for the network
... partOf Σ1..1Reference(VhDir Organization)Reference to organization that owns the network
... contact 0..*BackboneElementContact for the network for a certain purpose.
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... 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
..... contactpoint-availabletime 0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... contactpoint-viaintermediary 0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... 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 network

doco Documentation for this format

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationNetwork
... Slices for extension 0..*ExtensionExtension
Slice: 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
.... Slices for extension 0..*ExtensionExtension
Slice: 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..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... 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)Reference to organization that owns the network
... contact S0..*BackboneElementContact for the network for a certain purpose.
.... purpose S0..1CodeableConceptThe type of contact
.... name S0..1HumanNameA name associated with the contact
..... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
..... text S0..1stringText representation of the full name
..... family S1..1stringFamily name (often called 'Surname')
..... given S1..*stringGiven names (not always 'first'). Includes middle names
..... prefix S0..*stringParts that come before the name
..... suffix S0..*stringParts that come after the name
..... period S0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... Slices for extension 0..*ExtensionExtension
Slice: 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..1codephone | fax | email | pager | url | sms | other
..... value S1..1stringThe actual contact point details
..... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
..... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
..... period S0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
... 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..*OrganizationNetwork
... id Σ0..1stringLogical 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: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: 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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierIdentifies this network across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: 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 ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... 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(VhDir Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the network's record is still in active use.
... type SΣ0..*CodeableConceptType of network
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 network
... partOf SΣ1..1Reference(VhDir Organization)Reference to organization that owns the network
... contact S0..*BackboneElementContact for the network 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 S0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for 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): The use of a human name.

..... 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 S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: 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 SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period SΣ0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for the network

doco Documentation for this format

 

Other representations of profile: CSV, Excel, 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

Notes:

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