Validated Healthcare Directory Server Capability Statement Official URL http://hl7.org/fhir/uv/vhdir/CapabilityStatement/vhdir-server Implementation Guide Version 0.2.0 FHIR Version 4.0.1 Supported formats XML, JSON Published 2018 Published by HL7 International - Patient Administration Work Group This Capability Statement defines the expected capabilities of a validated healthcare directory FHIR server conforming to the Validated Healthcare Directory Implementation Guide. FHIR RESTful Capabilities Summary of System Wide Interactions MAY support the batch interaction. MAY support the search-system interaction. RESTful Capabilities by Resource/Profile: Summary Resource Type Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations Practitioner - endpoint, family, given, identifier-assigner, identifier, name, qualification-code, qualification-issuer, qualification-status, qualification-period, qualification-wherevalid-code, qualification-wherevalid-location, via-intermediary, active, phonetic Practitioner.practitioner-endpoint, Practitioner.practitioner-identifier-assigner, Practitioner.practitioner-qualification-issuer, Practitioner.practitioner-qualification-wherevalid-location, Practitioner.practitioner-via-intermediary VerificationResult.verificationresult-attestation.proxy, VerificationResult.verificationresult-attestation-who, PractitionerRole.practitionerrole-practitioner - PractitionerRole - endpoint, identifier-assigner, identifier, location, network, new-patient-network, new-patient, organization, practitioner, qualification-code, qualification-issuer, qualification-status, qualification-wherevalid-code, qualification-wherevalid-location, role, service, specialty, via-intermediary, active PractitionerRole.practitionerrole-endpoint, PractitionerRole.practitionerrole-identifier-assigner, PractitionerRole.practitionerrole-location, PractitionerRole.practitionerrole-network, PractitionerRole.practitionerrole-new-patient-network, PractitionerRole.practitionerrole-organization, PractitionerRole.practitionerrole-practitioner, PractitionerRole.practitionerrole-qualification-issuer, PractitionerRole.practitionerrole-qualification-wherevalid-location, PractitionerRole.practitionerrole-service, PractitionerRole.practitionerrole-via-intermediary CareTeam.participant, CareTeam.careteam-via-intermediary, Endpoint.endpoint-via-intermediary, HealthcareService.healthcareservice-via-intermediary, Location.location-via-intermediary, Organization.network-via-intermediary, Organization.organization-via-intermediary, OrganizationAffiliation.organizationaffiliation-via-intermediary, Practitioner.practitioner-via-intermediary, PractitionerRole.practitionerrole-via-intermediary - Organization VhDir Organization, VhDir Network active, address-country, address-postalcode, address-state, address, endpoint, identifier-assigner, identifier, name, partof, qualification-code, qualification-issuer, qualification-status, qualification-wherevalid-code, qualification-wherevalid-location, type, via-intermediary, address-use, address-city, coverage-area Organization.organization-organization-endpoint, Organization.organization-organization-identifier-assigner, Organization.organization-partof, Organization.organization-qualification-issuer, Organization.organization-qualification-wherevalid-location, Organization.organization-via-intermediary, Organization.organization-coverage-area, Organization.organization-network-via-intermediary, Organization.organization-organization-endpoint, Organization.organization-organization-identifier-assigner, Organization.organization-partof CareTeam.careteam-identifier-assigner, CareTeam.careteam-organization, Endpoint.endpoint-identifier-assigner, Endpoint.endpoint-organization, HealthcareService.healthcareservice-identifier-assigner, HealthcareService.healthcareservice-organization, InsurancePlan.insuranceplan-administered-by, InsurancePlan.insuranceplan-owned-by, Location.location-identifier-assigner, Location.location-organization, Organization.organization-identifier-assigner, Organization.organization-partof, Organization.organization-qualification-issuer, OrganizationAffiliation-organizationaffiliation-identifier-assigner, OrganizationAffiliation-organizationaffiliation-participating-organization, OrganizationAffiliation-organizationaffiliation-primary-organization, Practitioner.practitioner-identifier-assigner, Practitioner.practitioner-qualification-issuer, PractitionerRole.practitionerrole-identifier-assigner, PractitionerRole.practitionerrole-organization, PractitionerRole.practitionerrole-qualification-issuer, VerificationResult.verificationresult-primarysource-who, VerificationResult.verificationresult-validator-organization, VerificationResult.verificationresult-attestation-who, CareTeam.participant, CareTeam.careteam-via-intermediary, Endpoint.endpoint-via-intermediary, HealthcareService.healthcareservice-via-intermediary, Location.location-via-intermediary, Organization.network-via-intermediary, Organization.organization-via-intermediary, OrganizationAffiliation.organizationaffiliation-via-intermediary, Practitioner.practitioner-via-intermediary, PractitionerRole.practitionerrole-via-intermediary, HealthcareService.healthcareservice-new-patient-network, Location.location-new-patient-network, InsurancePlan.insuranceplan-coverage-network, InsurancePlan.insuranceplan-plan-network, InsurancePlan.insuranceplan-network, OrganizationAffiliation.organizationaffiliation-network, PractitionerRole.practitionerrole-new-patient-network, PractitionerRole.practitionerrole-network - OrganizationAffiliation - endpoint, identifier-assigner, identifier, location, network, participating-organization, primary-organization, role, service, specialty, via-intermediary, active OrganizationAffiliation.organizationaffiliation-endpoint, OrganizationAffiliation.organizationaffiliation-identifier-assigner, OrganizationAffiliation.organizationaffiliation-location, OrganizationAffiliation.organizationaffiliation-network, OrganizationAffiliation.organizationaffiliation-participating-organization, OrganizationAffiliation.organizationaffiliation-primary-organization, OrganizationAffiliation.organizationaffiliation-service, OrganizationAffiliation.organizationaffiliation-via-intermediary CareTeam.careteam-via-intermediary, Endpoint.endpoint-via-intermediary, HealthcareService.healthcareservice-via-intermediary, Location.location-via-intermediary, Organization.network-via-intermediary, Organization.organization-via-intermediary, OrganizationAffiliation.organizationaffiliation-via-intermediary, Practitioner.practitioner-via-intermediary, PractitionerRole.practitionerrole-via-intermediary - HealthcareService - service-category, characteristic, coverage-area, eligibility, endpoint, identifier-assigner, identifier, location, name, new-patient-network, new-patient, organization, specialty, service-type, via-intermediary, active HealthcareService.healthcareservice-coverage-area, HealthcareService.healthcareservice-endpoint, HealthcareService.healthcareservice-identifier-assigner, HealthcareService.healthcareservice-location, HealthcareService.healthcareservice-new-patient-network, HealthcareService.healthcareservice-organization, HealthcareService.healthcareservice-via-intermediary CareTeam.careteam-service, OrganizationAffiliation.organizationaffiliation-service, PractitionerRole.practitionerrole-service - Location - accessibility, address, endpoint, identifier-assigner, identifier, new-patient-network, new-patient, organization, partof, contains, near, status, type, via-intermediary Location.location-endpoint, Location.location-identifier-assigner, Location.location-new-patient-network, Location.location-organization, Location.location-partof, Location.location-via-intermediary CareTeam.careteam-location, HealthcareService.healthcareservice-coverage-area, HealthcareService.healthcareservice-location, InsurancePlan.insuranceplan-plan-coverage-area, InsurancePlan.insuranceplan-coverage-area, Location.location-partof, Organization.coverage-area, Organization.qualification-wherevalid-location, OrganizationAffiliation.organizationaffiliation-location, Practitioner.practitioner-qualification-wherevalid-location, PractitionerRole.practitionerrole-location, PractitionerRole.practitionerrole-qualification-wherevalid, CareTeam.careteam-via-intermediary, Endpoint.endpoint-via-intermediary, HealthcareService.healthcareservice-via-intermediary, Location.location-via-intermediary, Organization.network-via-intermediary, Organization.organization-via-intermediary, OrganizationAffiliation.organizationaffiliation-via-intermediary, Practitioner.practitioner-via-intermediary, PractitionerRole.practitionerrole-via-intermediary - CareTeam - category, endpoint, identifier-assigner, identifier, location, name, organization, service, status, via-intermediary, participant CareTeam.careteam-endpoint, CareTeam.careteam-identifier-assigner, CareTeam.careteam-location, CareTeam.careteam-organization, CareTeam.careteam-service, CareTeam.careteam-via-intermediary, CareTeam.participant CareTeam.participant - Endpoint VhDir Endpoint connection-type, identifier-assigner, identifier, mime-type, organization, payload-type, status, usecase-standard, usecase-type, via-intermediary Endpoint.endpoint-identifier-assigner, Endpoint.endpoint-organization, Endpoint.endpoint-via-intermediary CareTeam.careteam-endpoint, HealthcareService.healthcareservice-endpoint, InsurancePlan.insuranceplan-endpoint, Location.location-endpoint, Organization.organization-endpoint, OrganizationAffiliation.organizationaffiliation.endpoint, Practitioner.practitioner-endpoint, PractitionerRole.practitionerrole-endpoint - VerificationResult - attestation-who, attestation-method, attestation-onbehalfof, primarysource-date, primarysource-who, primarysource-type, status-date, validation-status, validator-organization, target VerificationResult.verificationresult-target, VerificationResult.verificationresult-attestation-who, VerificationResult.verificationresult-attestation-onbehalfof, VerificationResult.verificationresult-primarysource-who, VerificationResult.verificationresult-validator-organization - - Consent VhDir Restriction - - - - InsurancePlan - administered-by, coverage-benefit-type, coverage-limit-value, coverage-network, coverage-type, endpoint, general-cost-groupsize, general-cost-type, general-cost-value, name, owned-by, plan-coverage-area, plan-identifier, plan-network, plan-type, coverage-area, identifier, network, type, specific-cost-benefit-type, specific-cost-category, specific-cost-cost-type, specific-cost-value, status InsurancePlan.insuranceplan-coverage-area, InsurancePlan.insuranceplan-administered-by, InsurancePlan.insuranceplan-coverage-network, InsurancePlan.insuranceplan-endpoint, InsurancePlan.insuranceplan-owned-by, InsurancePlan.insuranceplan-plan-coverage-area, InsurancePlan.insuranceplan-plan-network, InsurancePlan.insuranceplan-network - - Practitioner Conformance Expectation: (conformance expectation undefined) Base System profile for all uses of resource: VhDir Practitioner Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, vread, history-instance, history-type, search-type. Fetch and Search Criteria: A Server SHALL be capable of returning a Practitioner resource using: GET [base]/Practitioner/[id] A Server SHOULD be capable of supporting the following _includes: Practitioner.practitioner-endpoint: GET [base]/Practitioner?[parameter=value]&_include=Practitioner.practitioner-endpoint Practitioner.practitioner-identifier-assigner: GET [base]/Practitioner?[parameter=value]&_include=Practitioner.practitioner-identifier-assigner Practitioner.practitioner-qualification-issuer: GET [base]/Practitioner?[parameter=value]&_include=Practitioner.practitioner-qualification-issuer Practitioner.practitioner-qualification-wherevalid-location: GET [base]/Practitioner?[parameter=value]&_include=Practitioner.practitioner-qualification-wherevalid-location Practitioner.practitioner-via-intermediary: GET [base]/Practitioner?[parameter=value]&_include=Practitioner.practitioner-via-intermediary A Server SHALL be capable of supporting the following _revincludes: VerificationResult.verificationresult-attestation.proxy - GET [base]/Practitioner?[parameter=value]&_revinclude=VerificationResult.verificationresult-attestation.proxy VerificationResult.verificationresult-attestation-who - GET [base]/Practitioner?[parameter=value]&_revinclude=VerificationResult.verificationresult-attestation-who PractitionerRole.practitionerrole-practitioner - GET [base]/Practitioner?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-practitioner Search Parameter Summary: Conformance Parameter Type SHOULD family string SHOULD given string SHALL identifier token SHALL name string SHOULD qualification-code token SHALL qualification-status token SHALL qualification-period date SHOULD qualification-wherevalid-code token SHALL active token Search Parameter Requirements (When Used Alone or in Combination): qualification-wherevalid-location (reference): Select Practitioners with a qualification that is valid at the specified location phonetic (string): Select Practitioners with the specified name (A portion of name using some kind of phonetic matching algorithm) PractitionerRole Conformance Expectation: (conformance expectation undefined) Base System profile for all uses of resource: VhDir Practitioner Role Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, vread, history-instance, history-type, search-type. Fetch and Search Criteria: A Server SHALL be capable of returning a PractitionerRole resource using: GET [base]/PractitionerRole/[id] A Server SHOULD be capable of supporting the following _includes: PractitionerRole.practitionerrole-endpoint: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-endpoint PractitionerRole.practitionerrole-identifier-assigner: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-identifier-assigner PractitionerRole.practitionerrole-location: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-location PractitionerRole.practitionerrole-network: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-network PractitionerRole.practitionerrole-new-patient-network: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-new-patient-network PractitionerRole.practitionerrole-organization: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-organization PractitionerRole.practitionerrole-practitioner: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-practitioner PractitionerRole.practitionerrole-qualification-issuer: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-qualification-issuer PractitionerRole.practitionerrole-qualification-wherevalid-location: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-qualification-wherevalid-location PractitionerRole.practitionerrole-service: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-service PractitionerRole.practitionerrole-via-intermediary: GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole.practitionerrole-via-intermediary A Server SHALL be capable of supporting the following _revincludes: CareTeam.participant - GET [base]/PractitionerRole?[parameter=value]&_revinclude=CareTeam.participant CareTeam.careteam-via-intermediary - GET [base]/PractitionerRole?[parameter=value]&_revinclude=CareTeam.careteam-via-intermediary Endpoint.endpoint-via-intermediary - GET [base]/PractitionerRole?[parameter=value]&_revinclude=Endpoint.endpoint-via-intermediary HealthcareService.healthcareservice-via-intermediary - GET [base]/PractitionerRole?[parameter=value]&_revinclude=HealthcareService.healthcareservice-via-intermediary Location.location-via-intermediary - GET [base]/PractitionerRole?[parameter=value]&_revinclude=Location.location-via-intermediary Organization.network-via-intermediary - GET [base]/PractitionerRole?[parameter=value]&_revinclude=Organization.network-via-intermediary Organization.organization-via-intermediary - GET [base]/PractitionerRole?[parameter=value]&_revinclude=Organization.organization-via-intermediary OrganizationAffiliation.organizationaffiliation-via-intermediary - GET [base]/PractitionerRole?[parameter=value]&_revinclude=OrganizationAffiliation.organizationaffiliation-via-intermediary Practitioner.practitioner-via-intermediary - GET [base]/PractitionerRole?[parameter=value]&_revinclude=Practitioner.practitioner-via-intermediary PractitionerRole.practitionerrole-via-intermediary - GET [base]/PractitionerRole?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-via-intermediary Search Parameter Summary: Conformance Parameter Type SHOULD endpoint reference SHALL identifier token SHALL location reference SHOULD network reference SHOULD new-patient-network reference SHOULD new-patient token SHALL organization reference SHALL practitioner reference SHOULD qualification-code token SHALL qualification-status token SHOULD qualification-wherevalid-code token SHOULD qualification-wherevalid-location reference SHALL role token SHOULD service reference SHOULD specialty token SHALL active token Organization Conformance Expectation: (conformance expectation undefined) Supported Profiles: VhDir Organization, VhDir Network Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, vread, history-instance, history-type, search-type. Fetch and Search Criteria: A Server SHALL be capable of returning a Organization resource using: GET [base]/Organization/[id] A Server SHOULD be capable of supporting the following _includes: Organization.organization-organization-endpoint: GET [base]/Organization?[parameter=value]&_include=Organization.organization-organization-endpoint Organization.organization-organization-identifier-assigner: GET [base]/Organization?[parameter=value]&_include=Organization.organization-organization-identifier-assigner Organization.organization-partof: GET [base]/Organization?[parameter=value]&_include=Organization.organization-partof Organization.organization-qualification-issuer: GET [base]/Organization?[parameter=value]&_include=Organization.organization-qualification-issuer Organization.organization-qualification-wherevalid-location: GET [base]/Organization?[parameter=value]&_include=Organization.organization-qualification-wherevalid-location Organization.organization-via-intermediary: GET [base]/Organization?[parameter=value]&_include=Organization.organization-via-intermediary Organization.organization-coverage-area: GET [base]/Organization?[parameter=value]&_include=Organization.organization-coverage-area Organization.organization-network-via-intermediary: GET [base]/Organization?[parameter=value]&_include=Organization.organization-network-via-intermediary Organization.organization-organization-endpoint: GET [base]/Organization?[parameter=value]&_include=Organization.organization-organization-endpoint Organization.organization-organization-identifier-assigner: GET [base]/Organization?[parameter=value]&_include=Organization.organization-organization-identifier-assigner Organization.organization-partof: GET [base]/Organization?[parameter=value]&_include=Organization.organization-partof A Server SHALL be capable of supporting the following _revincludes: CareTeam.careteam-identifier-assigner - GET [base]/Organization?[parameter=value]&_revinclude=CareTeam.careteam-identifier-assigner CareTeam.careteam-organization - GET [base]/Organization?[parameter=value]&_revinclude=CareTeam.careteam-organization Endpoint.endpoint-identifier-assigner - GET [base]/Organization?[parameter=value]&_revinclude=Endpoint.endpoint-identifier-assigner Endpoint.endpoint-organization - GET [base]/Organization?[parameter=value]&_revinclude=Endpoint.endpoint-organization HealthcareService.healthcareservice-identifier-assigner - GET [base]/Organization?[parameter=value]&_revinclude=HealthcareService.healthcareservice-identifier-assigner HealthcareService.healthcareservice-organization - GET [base]/Organization?[parameter=value]&_revinclude=HealthcareService.healthcareservice-organization InsurancePlan.insuranceplan-administered-by - GET [base]/Organization?[parameter=value]&_revinclude=InsurancePlan.insuranceplan-administered-by InsurancePlan.insuranceplan-owned-by - GET [base]/Organization?[parameter=value]&_revinclude=InsurancePlan.insuranceplan-owned-by Location.location-identifier-assigner - GET [base]/Organization?[parameter=value]&_revinclude=Location.location-identifier-assigner Location.location-organization - GET [base]/Organization?[parameter=value]&_revinclude=Location.location-organization Organization.organization-identifier-assigner - GET [base]/Organization?[parameter=value]&_revinclude=Organization.organization-identifier-assigner Organization.organization-partof - GET [base]/Organization?[parameter=value]&_revinclude=Organization.organization-partof Organization.organization-qualification-issuer - GET [base]/Organization?[parameter=value]&_revinclude=Organization.organization-qualification-issuer OrganizationAffiliation-organizationaffiliation-identifier-assigner - GET [base]/Organization?[parameter=value]&_revinclude=OrganizationAffiliation-organizationaffiliation-identifier-assigner OrganizationAffiliation-organizationaffiliation-participating-organization - GET [base]/Organization?[parameter=value]&_revinclude=OrganizationAffiliation-organizationaffiliation-participating-organization OrganizationAffiliation-organizationaffiliation-primary-organization - GET [base]/Organization?[parameter=value]&_revinclude=OrganizationAffiliation-organizationaffiliation-primary-organization Practitioner.practitioner-identifier-assigner - GET [base]/Organization?[parameter=value]&_revinclude=Practitioner.practitioner-identifier-assigner Practitioner.practitioner-qualification-issuer - GET [base]/Organization?[parameter=value]&_revinclude=Practitioner.practitioner-qualification-issuer PractitionerRole.practitionerrole-identifier-assigner - GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-identifier-assigner PractitionerRole.practitionerrole-organization - GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-organization PractitionerRole.practitionerrole-qualification-issuer - GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-qualification-issuer VerificationResult.verificationresult-primarysource-who - GET [base]/Organization?[parameter=value]&_revinclude=VerificationResult.verificationresult-primarysource-who VerificationResult.verificationresult-validator-organization - GET [base]/Organization?[parameter=value]&_revinclude=VerificationResult.verificationresult-validator-organization VerificationResult.verificationresult-attestation-who - GET [base]/Organization?[parameter=value]&_revinclude=VerificationResult.verificationresult-attestation-who CareTeam.participant - GET [base]/Organization?[parameter=value]&_revinclude=CareTeam.participant CareTeam.careteam-via-intermediary - GET [base]/Organization?[parameter=value]&_revinclude=CareTeam.careteam-via-intermediary Endpoint.endpoint-via-intermediary - GET [base]/Organization?[parameter=value]&_revinclude=Endpoint.endpoint-via-intermediary HealthcareService.healthcareservice-via-intermediary - GET [base]/Organization?[parameter=value]&_revinclude=HealthcareService.healthcareservice-via-intermediary Location.location-via-intermediary - GET [base]/Organization?[parameter=value]&_revinclude=Location.location-via-intermediary Organization.network-via-intermediary - GET [base]/Organization?[parameter=value]&_revinclude=Organization.network-via-intermediary Organization.organization-via-intermediary - GET [base]/Organization?[parameter=value]&_revinclude=Organization.organization-via-intermediary OrganizationAffiliation.organizationaffiliation-via-intermediary - GET [base]/Organization?[parameter=value]&_revinclude=OrganizationAffiliation.organizationaffiliation-via-intermediary Practitioner.practitioner-via-intermediary - GET [base]/Organization?[parameter=value]&_revinclude=Practitioner.practitioner-via-intermediary PractitionerRole.practitionerrole-via-intermediary - GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-via-intermediary HealthcareService.healthcareservice-new-patient-network - GET [base]/Organization?[parameter=value]&_revinclude=HealthcareService.healthcareservice-new-patient-network Location.location-new-patient-network - GET [base]/Organization?[parameter=value]&_revinclude=Location.location-new-patient-network InsurancePlan.insuranceplan-coverage-network - GET [base]/Organization?[parameter=value]&_revinclude=InsurancePlan.insuranceplan-coverage-network InsurancePlan.insuranceplan-plan-network - GET [base]/Organization?[parameter=value]&_revinclude=InsurancePlan.insuranceplan-plan-network InsurancePlan.insuranceplan-network - GET [base]/Organization?[parameter=value]&_revinclude=InsurancePlan.insuranceplan-network OrganizationAffiliation.organizationaffiliation-network - GET [base]/Organization?[parameter=value]&_revinclude=OrganizationAffiliation.organizationaffiliation-network PractitionerRole.practitionerrole-new-patient-network - GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-new-patient-network PractitionerRole.practitionerrole-network - GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-network Search Parameter Summary: Conformance Parameter Type SHALL active token SHOULD address-country string SHOULD address-postalcode string SHOULD address-state string SHALL address string SHALL endpoint reference SHALL identifier token SHALL name string SHALL partof reference SHOULD qualification-code token SHALL qualification-status token SHOULD qualification-wherevalid-code token SHOULD qualification-wherevalid-location reference SHALL type token SHOULD address-city string SHOULD coverage-area reference OrganizationAffiliation Conformance Expectation: (conformance expectation undefined) Base System profile for all uses of resource: VhDir Organization Affiliation Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, search-type. SHOULD support vread, history-instance. MAY support history-type. Fetch and Search Criteria: A Server SHALL be capable of returning a OrganizationAffiliation resource using: GET [base]/OrganizationAffiliation/[id] A Server SHOULD be capable of supporting the following _includes: OrganizationAffiliation.organizationaffiliation-endpoint: GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation.organizationaffiliation-endpoint OrganizationAffiliation.organizationaffiliation-identifier-assigner: GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation.organizationaffiliation-identifier-assigner OrganizationAffiliation.organizationaffiliation-location: GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation.organizationaffiliation-location OrganizationAffiliation.organizationaffiliation-network: GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation.organizationaffiliation-network OrganizationAffiliation.organizationaffiliation-participating-organization: GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation.organizationaffiliation-participating-organization OrganizationAffiliation.organizationaffiliation-primary-organization: GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation.organizationaffiliation-primary-organization OrganizationAffiliation.organizationaffiliation-service: GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation.organizationaffiliation-service OrganizationAffiliation.organizationaffiliation-via-intermediary: GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation.organizationaffiliation-via-intermediary A Server SHALL be capable of supporting the following _revincludes: CareTeam.careteam-via-intermediary - GET [base]/OrganizationAffiliation?[parameter=value]&_revinclude=CareTeam.careteam-via-intermediary Endpoint.endpoint-via-intermediary - GET [base]/OrganizationAffiliation?[parameter=value]&_revinclude=Endpoint.endpoint-via-intermediary HealthcareService.healthcareservice-via-intermediary - GET [base]/OrganizationAffiliation?[parameter=value]&_revinclude=HealthcareService.healthcareservice-via-intermediary Location.location-via-intermediary - GET [base]/OrganizationAffiliation?[parameter=value]&_revinclude=Location.location-via-intermediary Organization.network-via-intermediary - GET [base]/OrganizationAffiliation?[parameter=value]&_revinclude=Organization.network-via-intermediary Organization.organization-via-intermediary - GET [base]/OrganizationAffiliation?[parameter=value]&_revinclude=Organization.organization-via-intermediary OrganizationAffiliation.organizationaffiliation-via-intermediary - GET [base]/OrganizationAffiliation?[parameter=value]&_revinclude=OrganizationAffiliation.organizationaffiliation-via-intermediary Practitioner.practitioner-via-intermediary - GET [base]/OrganizationAffiliation?[parameter=value]&_revinclude=Practitioner.practitioner-via-intermediary PractitionerRole.practitionerrole-via-intermediary - GET [base]/OrganizationAffiliation?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-via-intermediary Search Parameter Summary: Conformance Parameter Type SHOULD endpoint reference SHALL identifier token SHALL location reference SHOULD network reference SHALL participating-organization reference SHALL primary-organization reference SHALL role token SHOULD service reference SHOULD specialty token SHALL active token HealthcareService Conformance Expectation: (conformance expectation undefined) Base System profile for all uses of resource: VhDir Healthcare Service Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, search-type. SHOULD support vread, history-instance. MAY support history-type. Fetch and Search Criteria: A Server SHALL be capable of returning a HealthcareService resource using: GET [base]/HealthcareService/[id] A Server SHOULD be capable of supporting the following _includes: HealthcareService.healthcareservice-coverage-area: GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService.healthcareservice-coverage-area HealthcareService.healthcareservice-endpoint: GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService.healthcareservice-endpoint HealthcareService.healthcareservice-identifier-assigner: GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService.healthcareservice-identifier-assigner HealthcareService.healthcareservice-location: GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService.healthcareservice-location HealthcareService.healthcareservice-new-patient-network: GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService.healthcareservice-new-patient-network HealthcareService.healthcareservice-organization: GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService.healthcareservice-organization HealthcareService.healthcareservice-via-intermediary: GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService.healthcareservice-via-intermediary A Server SHALL be capable of supporting the following _revincludes: CareTeam.careteam-service - GET [base]/HealthcareService?[parameter=value]&_revinclude=CareTeam.careteam-service OrganizationAffiliation.organizationaffiliation-service - GET [base]/HealthcareService?[parameter=value]&_revinclude=OrganizationAffiliation.organizationaffiliation-service PractitionerRole.practitionerrole-service - GET [base]/HealthcareService?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-service Search Parameter Summary: Conformance Parameter Type SHALL service-category token SHOULD coverage-area reference SHOULD eligibility token SHOULD endpoint reference SHALL identifier token SHALL location reference SHOULD name string SHOULD new-patient-network reference SHOULD new-patient token SHALL organization reference SHOULD specialty token SHOULD service-type token SHALL active token Location Conformance Expectation: (conformance expectation undefined) Base System profile for all uses of resource: VhDir Location Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, search-type. SHOULD support vread, history-instance. MAY support history-type. Fetch and Search Criteria: A Server SHALL be capable of returning a Location resource using: GET [base]/Location/[id] A Server SHOULD be capable of supporting the following _includes: Location.location-endpoint: GET [base]/Location?[parameter=value]&_include=Location.location-endpoint Location.location-identifier-assigner: GET [base]/Location?[parameter=value]&_include=Location.location-identifier-assigner Location.location-new-patient-network: GET [base]/Location?[parameter=value]&_include=Location.location-new-patient-network Location.location-organization: GET [base]/Location?[parameter=value]&_include=Location.location-organization Location.location-partof: GET [base]/Location?[parameter=value]&_include=Location.location-partof Location.location-via-intermediary: GET [base]/Location?[parameter=value]&_include=Location.location-via-intermediary A Server SHALL be capable of supporting the following _revincludes: CareTeam.careteam-location - GET [base]/Location?[parameter=value]&_revinclude=CareTeam.careteam-location HealthcareService.healthcareservice-coverage-area - GET [base]/Location?[parameter=value]&_revinclude=HealthcareService.healthcareservice-coverage-area HealthcareService.healthcareservice-location - GET [base]/Location?[parameter=value]&_revinclude=HealthcareService.healthcareservice-location InsurancePlan.insuranceplan-plan-coverage-area - GET [base]/Location?[parameter=value]&_revinclude=InsurancePlan.insuranceplan-plan-coverage-area InsurancePlan.insuranceplan-coverage-area - GET [base]/Location?[parameter=value]&_revinclude=InsurancePlan.insuranceplan-coverage-area Location.location-partof - GET [base]/Location?[parameter=value]&_revinclude=Location.location-partof Organization.coverage-area - GET [base]/Location?[parameter=value]&_revinclude=Organization.coverage-area Organization.qualification-wherevalid-location - GET [base]/Location?[parameter=value]&_revinclude=Organization.qualification-wherevalid-location OrganizationAffiliation.organizationaffiliation-location - GET [base]/Location?[parameter=value]&_revinclude=OrganizationAffiliation.organizationaffiliation-location Practitioner.practitioner-qualification-wherevalid-location - GET [base]/Location?[parameter=value]&_revinclude=Practitioner.practitioner-qualification-wherevalid-location PractitionerRole.practitionerrole-location - GET [base]/Location?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-location PractitionerRole.practitionerrole-qualification-wherevalid - GET [base]/Location?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-qualification-wherevalid CareTeam.careteam-via-intermediary - GET [base]/Location?[parameter=value]&_revinclude=CareTeam.careteam-via-intermediary Endpoint.endpoint-via-intermediary - GET [base]/Location?[parameter=value]&_revinclude=Endpoint.endpoint-via-intermediary HealthcareService.healthcareservice-via-intermediary - GET [base]/Location?[parameter=value]&_revinclude=HealthcareService.healthcareservice-via-intermediary Location.location-via-intermediary - GET [base]/Location?[parameter=value]&_revinclude=Location.location-via-intermediary Organization.network-via-intermediary - GET [base]/Location?[parameter=value]&_revinclude=Organization.network-via-intermediary Organization.organization-via-intermediary - GET [base]/Location?[parameter=value]&_revinclude=Organization.organization-via-intermediary OrganizationAffiliation.organizationaffiliation-via-intermediary - GET [base]/Location?[parameter=value]&_revinclude=OrganizationAffiliation.organizationaffiliation-via-intermediary Practitioner.practitioner-via-intermediary - GET [base]/Location?[parameter=value]&_revinclude=Practitioner.practitioner-via-intermediary PractitionerRole.practitionerrole-via-intermediary - GET [base]/Location?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-via-intermediary Search Parameter Summary: Conformance Parameter Type SHALL address string SHOULD endpoint reference SHALL identifier token SHOULD new-patient-network reference SHOULD new-patient token SHALL organization reference SHOULD partof reference SHALL status token SHALL type token CareTeam Conformance Expectation: (conformance expectation undefined) Base System profile for all uses of resource: VhDir Care Team Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, search-type. MAY support vread, history-instance, history-type. Fetch and Search Criteria: A Server SHALL be capable of returning a CareTeam resource using: GET [base]/CareTeam/[id] A Server SHOULD be capable of supporting the following _includes: CareTeam.careteam-endpoint: GET [base]/CareTeam?[parameter=value]&_include=CareTeam.careteam-endpoint CareTeam.careteam-identifier-assigner: GET [base]/CareTeam?[parameter=value]&_include=CareTeam.careteam-identifier-assigner CareTeam.careteam-location: GET [base]/CareTeam?[parameter=value]&_include=CareTeam.careteam-location CareTeam.careteam-organization: GET [base]/CareTeam?[parameter=value]&_include=CareTeam.careteam-organization CareTeam.careteam-service: GET [base]/CareTeam?[parameter=value]&_include=CareTeam.careteam-service CareTeam.careteam-via-intermediary: GET [base]/CareTeam?[parameter=value]&_include=CareTeam.careteam-via-intermediary CareTeam.participant: GET [base]/CareTeam?[parameter=value]&_include=CareTeam.participant A Server SHALL be capable of supporting the following _revincludes: CareTeam.participant - GET [base]/CareTeam?[parameter=value]&_revinclude=CareTeam.participant Search Parameter Summary: Conformance Parameter Type SHOULD endpoint reference SHALL identifier token SHALL location reference SHOULD name string SHALL organization reference SHOULD service reference SHALL status token SHALL participant reference Endpoint Conformance Expectation: (conformance expectation undefined) Supported Profiles: VhDir Endpoint Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, search-type. MAY support vread, history-instance, history-type. Fetch and Search Criteria: A Server SHALL be capable of returning a Endpoint resource using: GET [base]/Endpoint/[id] A Server SHOULD be capable of supporting the following _includes: Endpoint.endpoint-identifier-assigner: GET [base]/Endpoint?[parameter=value]&_include=Endpoint.endpoint-identifier-assigner Endpoint.endpoint-organization: GET [base]/Endpoint?[parameter=value]&_include=Endpoint.endpoint-organization Endpoint.endpoint-via-intermediary: GET [base]/Endpoint?[parameter=value]&_include=Endpoint.endpoint-via-intermediary A Server SHALL be capable of supporting the following _revincludes: CareTeam.careteam-endpoint - GET [base]/Endpoint?[parameter=value]&_revinclude=CareTeam.careteam-endpoint HealthcareService.healthcareservice-endpoint - GET [base]/Endpoint?[parameter=value]&_revinclude=HealthcareService.healthcareservice-endpoint InsurancePlan.insuranceplan-endpoint - GET [base]/Endpoint?[parameter=value]&_revinclude=InsurancePlan.insuranceplan-endpoint Location.location-endpoint - GET [base]/Endpoint?[parameter=value]&_revinclude=Location.location-endpoint Organization.organization-endpoint - GET [base]/Endpoint?[parameter=value]&_revinclude=Organization.organization-endpoint OrganizationAffiliation.organizationaffiliation.endpoint - GET [base]/Endpoint?[parameter=value]&_revinclude=OrganizationAffiliation.organizationaffiliation.endpoint Practitioner.practitioner-endpoint - GET [base]/Endpoint?[parameter=value]&_revinclude=Practitioner.practitioner-endpoint PractitionerRole.practitionerrole-endpoint - GET [base]/Endpoint?[parameter=value]&_revinclude=PractitionerRole.practitionerrole-endpoint Search Parameter Summary: Conformance Parameter Type SHALL connection-type token SHALL identifier token SHALL organization reference SHOULD payload-type token SHALL status token SHOULD usecase-standard uri SHOULD usecase-type token VerificationResult Conformance Expectation: (conformance expectation undefined) Base System profile for all uses of resource: VhDir Validation Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, vread, history-instance, search-type. SHOULD support history-type. Fetch and Search Criteria: A Server SHALL be capable of returning a VerificationResult resource using: GET [base]/VerificationResult/[id] A Server SHOULD be capable of supporting the following _includes: VerificationResult.verificationresult-target: GET [base]/VerificationResult?[parameter=value]&_include=VerificationResult.verificationresult-target VerificationResult.verificationresult-attestation-who: GET [base]/VerificationResult?[parameter=value]&_include=VerificationResult.verificationresult-attestation-who VerificationResult.verificationresult-attestation-onbehalfof: GET [base]/VerificationResult?[parameter=value]&_include=VerificationResult.verificationresult-attestation-onbehalfof VerificationResult.verificationresult-primarysource-who: GET [base]/VerificationResult?[parameter=value]&_include=VerificationResult.verificationresult-primarysource-who VerificationResult.verificationresult-validator-organization: GET [base]/VerificationResult?[parameter=value]&_include=VerificationResult.verificationresult-validator-organization Search Parameter Summary: Conformance Parameter Type SHALL attestation-who reference SHOULD attestation-method token SHALL attestation-onbehalfof reference SHOULD primarysource-date date SHALL primarysource-who reference SHOULD primarysource-type token SHOULD status-date date SHALL validation-status token SHALL validator-organization reference Search Parameter Requirements (When Used Alone or in Combination): target (reference): Select validation information for the specified resource Consent Conformance Expectation: (conformance expectation undefined) Supported Profiles: VhDir Restriction InsurancePlan Conformance Expectation: (conformance expectation undefined) Base System profile for all uses of resource: VhDir Insurance Plan Reference Policy: literal, local Versioning Policy: versioned Profile Interaction Summary: SHALL support read, search-type. MAY support vread, history-instance, history-type. Fetch and Search Criteria: A Server SHALL be capable of returning a InsurancePlan resource using: GET [base]/InsurancePlan/[id] A Server SHOULD be capable of supporting the following _includes: InsurancePlan.insuranceplan-coverage-area: GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan.insuranceplan-coverage-area InsurancePlan.insuranceplan-administered-by: GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan.insuranceplan-administered-by InsurancePlan.insuranceplan-coverage-network: GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan.insuranceplan-coverage-network InsurancePlan.insuranceplan-endpoint: GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan.insuranceplan-endpoint InsurancePlan.insuranceplan-owned-by: GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan.insuranceplan-owned-by InsurancePlan.insuranceplan-plan-coverage-area: GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan.insuranceplan-plan-coverage-area InsurancePlan.insuranceplan-plan-network: GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan.insuranceplan-plan-network InsurancePlan.insuranceplan-network: GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan.insuranceplan-network Search Parameter Summary: Conformance Parameter Type SHOULD administered-by reference SHALL coverage-benefit-type token SHALL coverage-network reference SHALL coverage-type token SHOULD endpoint reference SHOULD name string SHALL owned-by reference SHOULD plan-coverage-area reference SHALL plan-identifier token SHALL plan-network reference SHALL plan-type token SHOULD coverage-area reference SHALL identifier token SHALL network reference SHALL type token SHOULD specific-cost-benefit-type token SHOULD specific-cost-category token SHALL status token
Validated Healthcare Directory Server Capability Statement
HL7 International / Patient Administration
This Capability Statement defines the expected capabilities of a validated healthcare directory FHIR server conforming to the Validated Healthcare Directory Implementation Guide.
Used by permission of HL7 International all rights reserved Creative Commons License
Select Practitioners with a qualification that is valid at the specified location
Select Practitioners with the specified name (A portion of name using some kind of phonetic matching algorithm)
Select validation information for the specified resource