HL7 FHIR® Validated Healthcare Directory Implementation Guide STU 1

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

Table of Contents

  1 - Home

  2 - Guidance

    2.1 - General Guidance

    2.2 - Technical Guidance

    2.3 - Bulk Data and Subscriptions

  3 - Profiles and Extensions

    3.1 - StructureDefinition Vhdir Validation

    3.2 - StructureDefinition Vhdir Restriction

    3.3 - StructureDefinition Vhdir Practitionerrole

    3.4 - StructureDefinition Vhdir Practitioner

    3.5 - StructureDefinition Vhdir Organizationaffiliation

    3.6 - StructureDefinition Vhdir Organization

    3.7 - StructureDefinition Vhdir Network

    3.8 - StructureDefinition Vhdir Location

    3.9 - StructureDefinition Vhdir Insuranceplan

    3.1 - StructureDefinition Vhdir Healthcareservice

    3.11 - StructureDefinition Vhdir Endpoint

    3.12 - StructureDefinition Vhdir Careteam

    3.13 - StructureDefinition Usage Restriction

    3.14 - StructureDefinition Qualification

    3.15 - StructureDefinition Practitioner Qualification

    3.16 - StructureDefinition Org Description

    3.17 - StructureDefinition Org Alias Type

    3.18 - StructureDefinition Org Alias Period

    3.19 - StructureDefinition Newpatients

    3.2 - StructureDefinition Newpatientprofile

    3.21 - StructureDefinition Network Reference

    3.22 - StructureDefinition Location Reference

    3.23 - StructureDefinition Insuranceplan Reference

    3.24 - StructureDefinition Identifier Status

    3.25 - StructureDefinition Healthcareservice Reference

    3.26 - StructureDefinition Endpoint Usecase

    3.27 - StructureDefinition Endpoint Reference

    3.28 - StructureDefinition Endpoint Rank

    3.29 - StructureDefinition Ehr

    3.3 - StructureDefinition Digitalcertificate

    3.31 - StructureDefinition Contactpoint Viaintermediary

    3.32 - StructureDefinition Contactpoint Availabletime

    3.33 - StructureDefinition Communication Proficiency

    3.34 - StructureDefinition Careteam Alias

    3.35 - StructureDefinition Accessibility

  4 - Terminology

    4.1 - ValueSet Validationprocess

    4.2 - ValueSet Validationneed

    4.3 - ValueSet Usecasetype

    4.4 - ValueSet Qualificationstatus

    4.5 - ValueSet Primarysourcevalidationstatus

    4.6 - ValueSet Primarysourcevalidationprocess

    4.7 - ValueSet Primarysourcetype

    4.8 - ValueSet Primarysourcepushtype

    4.9 - ValueSet Primarysourcepush

    4.1 - ValueSet Primarysourcefailureaction

    4.11 - ValueSet Plan Type

    4.12 - ValueSet Patientaccess

    4.13 - ValueSet Network Type

    4.14 - ValueSet Limit Unit

    4.15 - ValueSet Languageproficiency

    4.16 - ValueSet Insuranceplangroupsize

    4.39 - ValueSet Insurance Plan Cost Type

    4.18 - ValueSet Insuranceplancostcategory

    4.19 - ValueSet Insuranceplanbenefittype

    4.2 - ValueSet Insuranceplanbenefitcosttype

    4.21 - ValueSet Insuranceplan Type

    4.22 - ValueSet Identifier status

    4.23 - ValueSet Identifier Type

    4.24 - ValueSet Failureaction

    4.25 - ValueSet Externalvalidationtype

    4.26 - ValueSet Digitalcertificateuse

    4.27 - ValueSet Digitalcertificatetype

    4.28 - ValueSet Digitalcertificatetrustframework

    4.29 - ValueSet Digitalcertificatestandard

    4.3 - ValueSet Coverage Type

    4.31 - ValueSet Certificationedition

    4.32 - ValueSet Benefit Type

    4.33 - ValueSet Attestationmethod

    4.34 - ValueSet Aliastype

    4.35 - ValueSet Accessibility

    4.36 - ValueSet Consent

    4.37 - ValueSet Healthcare Service Characteristic

    4.38 - ValueSet Healthcare Service Eligibility

    4.4 - CodeSystem Validation

    4.41 - CodeSystem Usecase

    4.42 - CodeSystem Primarysource

    4.43 - CodeSystem Payercharacteristics

    4.44 - CodeSystem Organizationdemographics

    4.45 - CodeSystem Network Type

    4.46 - CodeSystem Languageproficiency

    4.47 - CodeSystem Insuranceplan

    4.48 - CodeSystem Ehrcharacteristics

    4.49 - CodeSystem Digitalcertificate

    4.5 - CodeSystem Credentialstatus

    4.51 - CodeSystem Accessibility

    4.52 - CodeSystem Consent

    4.53 - ConceptMap Qualification Status

  5 - Search Parameters

    5.1 - SearchParameter Verificationresult Validator Organization

    5.2 - SearchParameter Verificationresult Validation Status

    5.3 - SearchParameter Verificationresult Target

    5.4 - SearchParameter Practitioner Qualification Period

    5.5 - SearchParameter Verificationresult Status Date

    5.6 - SearchParameter Verificationresult Primarysource Type

    5.7 - SearchParameter Verificationresult Primarysource Who

    5.8 - SearchParameter Verificationresult Primarysource Date

    5.9 - SearchParameter Verificationresult Attestation On Behalf Of

    5.1 - SearchParameter Verificationresult Attestation Method

    5.11 - SearchParameter Verificationresult Attestation Who

    5.12 - SearchParameter Practitionerrole Via Intermediary

    5.13 - SearchParameter Practitionerrole Specialty

    5.14 - SearchParameter Practitionerrole Service

    5.15 - SearchParameter Practitionerrole Role

    5.16 - SearchParameter Practitionerrole Qualification Wherevalid Location

    5.17 - SearchParameter Practitionerrole Qualification Wherevalid Code

    5.18 - SearchParameter Practitionerrole Qualification Status

    5.19 - SearchParameter Practitionerrole Qualification Issuer

    5.2 - SearchParameter Practitionerrole Qualification Code

    5.21 - SearchParameter Practitionerrole Practitioner

    5.22 - SearchParameter Practitionerrole Organization

    5.23 - SearchParameter Practitionerrole New Patient

    5.24 - SearchParameter Practitionerrole New Patient Network

    5.25 - SearchParameter Practitionerrole Network

    5.26 - SearchParameter Practitionerrole Location

    5.27 - SearchParameter Practitionerrole Identifier

    5.28 - SearchParameter Practitionerrole Identifier Assigner

    5.29 - SearchParameter Practitionerrole Endpoint

    5.3 - SearchParameter Practitioner Via Intermediary

    5.31 - SearchParameter Practitioner Qualification Wherevalid Location

    5.32 - SearchParameter Practitioner Qualification Wherevalid Code

    5.33 - SearchParameter Practitioner Qualification Status

    5.34 - SearchParameter Practitioner Qualification Issuer

    5.35 - SearchParameter Practitioner Qualification Code

    5.36 - SearchParameter Practitioner Phonetic

    5.37 - SearchParameter Practitioner Name

    5.38 - SearchParameter Practitioner Identifier

    5.39 - SearchParameter Practitioner Identifier Assigner

    5.4 - SearchParameter Practitioner Given Name

    5.41 - SearchParameter Practitioner Family Name

    5.42 - SearchParameter Practitioner Endpoint

    5.43 - SearchParameter Organizationaffiliation Via Intermediary

    5.44 - SearchParameter Organizationaffiliation Specialty

    5.45 - SearchParameter Organizationaffiliation Service

    5.46 - SearchParameter Organizationaffiliation Role

    5.47 - SearchParameter Organizationaffiliation Primary Organization

    5.48 - SearchParameter Organizationaffiliation Participating Organization

    5.49 - SearchParameter Organizationaffiliation Network

    5.5 - SearchParameter Organizationaffiliation Location

    5.51 - SearchParameter Organizationaffiliation Identifier

    5.52 - SearchParameter Organizationaffiliation Identifier Assigner

    5.53 - SearchParameter Organizationaffiliation Endpoint

    5.54 - SearchParameter Organization Via Intermediary

    5.55 - SearchParameter Organization Type

    5.56 - SearchParameter Organization Qualification Wherevalid Location

    5.57 - SearchParameter Organization Qualification Wherevalid Code

    5.58 - SearchParameter Organization Qualification Status

    5.59 - SearchParameter Organization Qualification Issuer

    5.6 - SearchParameter Organization Qualification Code

    5.61 - SearchParameter Organization Partof

    5.62 - SearchParameter Organization Name

    5.63 - SearchParameter Organization Identifier

    5.64 - SearchParameter Organization Identifier Assigner

    5.65 - SearchParameter Organization Endpoint

    5.66 - SearchParameter Organization Address

    5.67 - SearchParameter Organization Address State

    5.68 - SearchParameter Organization Address Postalcode

    5.69 - SearchParameter Organization Address Country

    5.7 - SearchParameter Organization Address City

    5.71 - SearchParameter Network Coverage Area

    5.72 - SearchParameter Location Via Intermediary

    5.73 - SearchParameter Location Type

    5.74 - SearchParameter Location Status

    5.75 - SearchParameter Location Partof

    5.76 - SearchParameter Location Organization

    5.77 - SearchParameter Location New Patient

    5.78 - SearchParameter Location New Patient Network

    5.79 - SearchParameter Location Identifier

    5.8 - SearchParameter Location Identifier Assigner

    5.81 - SearchParameter Location Endpoint

    5.82 - SearchParameter Location Contains

    5.83 - SearchParameter Location Address

    5.84 - SearchParameter Location Accessibility

    5.85 - SearchParameter Insuranceplan Status

    5.86 - SearchParameter Insuranceplan Specific Cost Value

    5.87 - SearchParameter Insuranceplan Specific Cost Cost Type

    5.88 - SearchParameter Insuranceplan Specific Cost Category

    5.89 - SearchParameter Insuranceplan Specific Cost Benefit Type

    5.9 - SearchParameter Insuranceplan Product Type

    5.91 - SearchParameter Insuranceplan Product Network

    5.92 - SearchParameter Insuranceplan Product Identifier

    5.93 - SearchParameter Insuranceplan Product Coverage Area

    5.94 - SearchParameter Insuranceplan Plan Type

    5.95 - SearchParameter Insuranceplan Plan Network

    5.96 - SearchParameter Insuranceplan Plan Identifier

    5.97 - SearchParameter Insuranceplan Plan Coverage Area

    5.98 - SearchParameter Insuranceplan Owned By

    5.99 - SearchParameter Insuranceplan Name

    5.1 - SearchParameter Insuranceplan General Cost Value

    5.101 - SearchParameter Insuranceplan General Cost Type

    5.102 - SearchParameter Insuranceplan General Cost Groupsize

    5.103 - SearchParameter Insuranceplan Endpoint

    5.104 - SearchParameter Insuranceplan Coverage Type

    5.105 - SearchParameter Insuranceplan Coverage Network

    5.106 - SearchParameter Insuranceplan Coverage Limit Value

    5.107 - SearchParameter Insuranceplan Coverage Benefit Type

    5.108 - SearchParameter Insuranceplan Administered By

    5.109 - SearchParameter Healthcareservice Via Intermediary

    5.11 - SearchParameter Healthcareservice Type

    5.111 - SearchParameter Healthcareservice Specialty

    5.112 - SearchParameter Healthcareservice Organization

    5.113 - SearchParameter Healthcareservice New Patient

    5.114 - SearchParameter Healthcareservice New Patient Network

    5.115 - SearchParameter Healthcareservice Name

    5.116 - SearchParameter Healthcareservice Location

    5.117 - SearchParameter Healthcareservice Identifier

    5.118 - SearchParameter Healthcareservice Identifier Assigner

    5.119 - SearchParameter Healthcareservice Endpoint

    5.12 - SearchParameter Healthcareservice Eligibility

    5.121 - SearchParameter Healthcareservice Coverage Area

    5.122 - SearchParameter Healthcareservice Characteristic

    5.123 - SearchParameter Healthcareservice Category

    5.124 - SearchParameter Endpoint Via Intermediary

    5.125 - SearchParameter Endpoint Usecase Type

    5.126 - SearchParameter Endpoint Usecase Standard

    5.127 - SearchParameter Endpoint Status

    5.128 - SearchParameter Endpoint Payload Type

    5.129 - SearchParameter Endpoint Organization

    5.13 - SearchParameter Endpoint Mime Type

    5.131 - SearchParameter Endpoint Identifier

    5.132 - SearchParameter Endpoint Identifier Assigner

    5.133 - SearchParameter Endpoint Connection Type

    5.134 - SearchParameter Careteam Via Intermediary

    5.135 - SearchParameter Careteam Status

    5.136 - SearchParameter Careteam Service

    5.137 - SearchParameter Careteam Organization

    5.138 - SearchParameter Careteam Name

    5.139 - SearchParameter Careteam Member

    5.14 - SearchParameter Careteam Location

    5.141 - SearchParameter Careteam Identifier

    5.142 - SearchParameter Careteam Identifier Assigner

    5.143 - SearchParameter Careteam Endpoint

    5.144 - SearchParameter Careteam Category

  6 - Capability Statements

    6.1 - CapabilityStatement Vhdir Server

  7 - Security

  8 - Downloads

  9 - All Examples

  10 - Table of Contents