National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

CapabilityStatement: NDH Exchange Base Server Capability Statement

Official URL: http://hl7.org/fhir/us/ndh/CapabilityStatement/ndh-exchange-base-server Version: 1.0.0-ballot
Active as of 2022-11-01 Computable Name: NdhExchangeBaseServerCapabilityStatement

This Section describes the expected capabilities of the NDH Server actor which is responsible for providing responses to the queries submitted by the NDH Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by NDH Servers are defined. NDH Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.

Raw OpenAPI-Swagger Definition file | Download


General

Supported FHIR Version: 4.0.1
Supported exchange formats: xml, json

Jump to:


REST server behavior

NDH Exchange Base Server


Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete Operations
Endpoint SHALL SHALL SHALL SHALL SHALL
CareTeam SHOULD SHOULD SHOULD SHOULD SHOULD
HealthcareService SHOULD SHOULD SHOULD SHOULD SHOULD
InsurancePlan SHOULD SHOULD SHOULD SHOULD SHOULD
Location SHALL SHALL SHALL SHALL SHALL
Organization SHALL SHALL SHALL SHALL SHALL
OrganizationAffiliation SHOULD SHOULD SHOULD SHOULD SHOULD
Practitioner SHALL SHALL SHALL SHALL SHALL
PractitionerRole SHALL SHALL SHALL SHALL SHALL
Consent SHOULD SHOULD SHOULD SHOULD SHOULD
VerificationResult SHOULD SHOULD SHOULD SHOULD SHOULD

Operations:



Endpoint

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  read SHALL

Read the current state of the resource
  vread SHALL

Read the state of a specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: Endpoint:organization

Supported Reverse-Includes: CareTeam:careteam-endpoint, HealthcareService:endpoint, InsurancePlan:endpoint, Location:endpoint, Location:endpoint, Organization:endpoint, OrganizationAffiliation:endpoint, Practitioner:practitioner-endpoint, PractitionerRole:endpoint

Parameter Name Definition Conformance Type Description
endpoint-usecase-type EndpointUsecaseTypeSearchParameter SHALL token

Endpoint usecase type
endpoint-nonfhir-usecase-type EndpointNonfhirUsecaseTypeSearchParameter SHALL token

Endpoint nonfhir usecase type
endpoint-trust-framework-type EndpointTrustFrameworkTypeSearchParameter SHALL token

Endpoint trust framework type
endpoint-dynamic-registration-trust-profile EndpointDynamicRegistrationTrustProfileSearchParameter SHALL token

Endpoint dynamic registration trust profile
endpoint-access-control-mechanism EndpointAccessControlMechanismSearchParameter SHALL token

Endpoint access control mechanism
endpoint-connection-type-version EndpointConnectionTypeVersionSearchParameter SHALL token

Endpoint connection type version
endpoint-ihe-connection-type EndpointIheConnectionTypeSearchParameter SHALL token

Endpoint ihe connection type
endpoint-verification-status EndpointVerificationStatusSearchParameter SHALL token

Endpoint verification status
_id http://hl7.org/fhir/SearchParameter/Resource-id SHALL token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHALL date

Allows filtering for only records that have changed since last query.
connection-type http://hl7.org/fhir/SearchParameter/Endpoint-connection-type SHALL token

Connection type
identifier http://hl7.org/fhir/SearchParameter/Endpoint-identifier SHALL token

Endpoint identifier
organization http://hl7.org/fhir/SearchParameter/Endpoint-organization SHALL reference

Organization that manages the Endpoint
status http://hl7.org/fhir/SearchParameter/Endpoint-status SHALL token

Endpoint status


CareTeam

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  read SHOULD

Read the current state of the resource
  vread SHOULD

Read the state of a specific version of the resource
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type

Search

Supported Includes: CareTeam:careteam-location, CareTeam:careteam-organization, CareTeam:careteam-service

Parameter Name Definition Conformance Type Description
careteam-location CareTeamLocationSearchParameter SHOULD reference

Location of the CareTeam
careteam-organization CareTeamOrganizationSearchParameter SHOULD reference

Organization of the CareTeam
careteam-service CareTeamServiceSearchParameter SHOULD reference

Service of the CareTeam
careteam-name CareTeamServiceSearchParameter SHOULD string

Name of the CareTeam
careteam-verification-status CareTeamVerificationStatusSearchParameter SHOULD token

Verification status of the CareTeam
_id http://hl7.org/fhir/SearchParameter/Resource-id SHOULD token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHOULD date

Allows filtering for only records that have changed since last query.
category http://hl7.org/fhir/SearchParameter/CareTeam-category SHOULD token

Type of team
participant http://hl7.org/fhir/SearchParameter/CareTeam-participant SHOULD reference

Who is involved
status http://hl7.org/fhir/SearchParameter/CareTeam-status SHOULD token

Status of the CareTeam


HealthcareService

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  read SHOULD

Read the current state of the resource
  vread SHOULD

Read the state of a specific version of the resource
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type

Search

Supported Includes: HealthcareService:coverage-area, HealthcareService:endpoint, HealthcareService:location, HealthcareService:healthcareservice-new-patient-from-network, HealthcareService:organization

Supported Reverse-Includes: CareTeam:careteam-service, OrganizationAffiliation:service, PractitionerRole:service

Parameter Name Definition Conformance Type Description
healthcareservice-new-patient-from-network HealthcareServiceNewPatientFromNetworkSearchParameter SHOULD reference

New patient from network
healthcareservice-eligibility HealthcareServiceEligibilitySearchParameter SHOULD token

Eligibility
healthcareservice-new-patient HealthcareServiceNewPatientSearchParameter SHOULD token

New patient
healthcareservice-verification-status HealthcareServiceVerificationStatusSearchParameter SHOULD token

Verification status
healthcareservice-network HealthcareServiceNetworkSearchParameter SHOULD reference

Network
healthcareservice-program-requirement-age-group HealthcareServiceProgramRequirementAgeGroupSearchParameter SHOULD token

Program requirement age group
healthcareservice-program-requirement-birthsex HealthcareServiceProgramRequirementBirthsexSearchParameter SHOULD token

Program requirement birthsex
healthcareservice-program-requirement-gender-identity HealthcareServiceProgramRequirementGenderIdentitySearchParameter SHOULD token

Program requirement gender identity
healthcareservice-program-requirement-employment-status HealthcareServiceProgramRequirementEmploymentStatusSearchParameter SHOULD token

Program requirement employment status
healthcareservice-program-requirement-insurance-status HealthcareServiceProgramRequirementInsuranceStatusSearchParameter SHOULD token

Program requirement insurance status
healthcareservice-program-requirement-va-status HealthcareServiceProgramRequirementVaStatusSearchParameter SHOULD token

Program requirement va status
healthcareservice-program-requirement-preferred-language HealthcareServiceProgramRequirementPreferredLanguageSearchParameter SHOULD token

Program requirement preferred language
healthcareservice-social-service-age-group HealthcareServiceSocialServiceAgeGroupSearchParameter SHOULD token

Social service requirement age group
healthcareservice-social-service-birthsex HealthcareServiceSocialServiceBirthsexSearchParameter SHOULD token

Social service requirement birthsex
healthcareservice-social-service-gender-identity HealthcareServiceSocialServiceGenderIdentitySearchParameter SHOULD token

Social service requirement gender identity
healthcareservice-social-service-employment-status HealthcareServiceSocialServiceEmploymentStatusSearchParameter SHOULD token

Social service requirement employment status
healthcareservice-social-service-insurance-status HealthcareServiceSocialServiceInsuranceStatusSearchParameter SHOULD token

Social service requirement insurance status
healthcareservice-social-service-va-status HealthcareServiceSocialServiceVaStatusSearchParameter SHOULD token

Social service requirement va status
healthcareservice-social-service-preferred-language HealthcareServiceSocialServicePreferredLanguageSearchParameter SHOULD token

Social service requirement preferred language
_id http://hl7.org/fhir/SearchParameter/Resource-id SHOULD token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHOULD date

Allows filtering for only records that have changed since last query.
active http://hl7.org/fhir/SearchParameter/HealthcareService-active SHOULD token

Whether this HealthcareService record is in active use
coverage-area http://hl7.org/fhir/SearchParameter/HealthcareService-coverage-area SHOULD reference

Location service is inteded for/available to
endpoint http://hl7.org/fhir/SearchParameter/HealthcareService-endpoint SHOULD reference

Technical endpoints providing access to services operated for the location
identifier http://hl7.org/fhir/SearchParameter/HealthcareService-identifier SHOULD token

External identifiers for this item
location http://hl7.org/fhir/SearchParameter/HealthcareService-location SHOULD reference

The location of the Healthcare Service
name http://hl7.org/fhir/SearchParameter/HealthcareService-name SHOULD string

A portion of the Healthcare service name
organization http://hl7.org/fhir/SearchParameter/HealthcareService-organization SHOULD reference

The organization that provides this Healthcare Service
program http://hl7.org/fhir/SearchParameter/HealthcareService-program SHOULD token

One of the Program Names that categorize the service
service-category http://hl7.org/fhir/SearchParameter/HealthcareService-service-category SHOULD token

Service Category of the Healthcare Service
service-type http://hl7.org/fhir/SearchParameter/HealthcareService-service-type SHOULD token

The type of service provided by this healthcare service
specialty http://hl7.org/fhir/SearchParameter/HealthcareService-specialty SHOULD token

Specialties handled by the HealthcareService


InsurancePlan

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  read SHOULD

Read the current state of the resource
  vread SHOULD

Read the state of a specific version of the resource
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type

Search

Supported Includes: InsurancePlan:administered-by, InsurancePlan:endpoint, InsurancePlan:owned-by, InsurancePlan:insuranceplan-coverage-area, InsurancePlan:insuranceplan-coverage-network, InsurancePlan:insuranceplan-plan-coverage-area, InsurancePlan:insuranceplan-plan-network, InsurancePlan:insuranceplan-network

Parameter Name Definition Conformance Type Description
insuranceplan-coverage-area InsuranceCoverageAreaSearchParameter SHOULD reference

InsurancePlan coverage area
insuranceplan-coverage-benefit-type InsuranceplanCoverageBenefitTypeSearchParameter SHOULD token

InsurancePlan coverage benefit type
insuranceplan-coverage-type InsuranceplanCoverageTypeSearchParameter SHOULD token

InsurancePlan coverage type
insuranceplan-coverage-network InsuranceplanCoverageNetworkSearchParameter SHOULD reference

InsurancePlan coverage network
insuranceplan-network InsuranceplanPlanNetworkSearchParameter SHOULD reference

InsurancePlan network
insuranceplan-plan-network InsuranceplanPlanNetworkSearchParameter SHOULD reference

InsurancePlan plan network
insuranceplan-plan-type InsuranceplanPlanTypeSearchParameter SHOULD token

InsurancePlan plan type
insuranceplan-verification-status InsuranceplanVerificationStatusSearchParameter SHOULD token

Verification status
_id http://hl7.org/fhir/SearchParameter/Resource-id SHOULD token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHOULD date

Allows filtering for only records that have changed since last query.
address http://hl7.org/fhir/SearchParameter/InsurancePlan-address SHOULD string

InsurancePlan contact address
address-city http://hl7.org/fhir/SearchParameter/InsurancePlan-address-city SHOULD string

InsurancePlan contact address-city
address-country http://hl7.org/fhir/SearchParameter/InsurancePlan-address-country SHOULD string

InsurancePlan contact address-country
address-postalcode http://hl7.org/fhir/SearchParameter/InsurancePlan-address-postalcode SHOULD string

InsurancePlan contact address-postalcode
address-state http://hl7.org/fhir/SearchParameter/InsurancePlan-address-state SHOULD string

InsurancePlan contact address-state
administered-by http://hl7.org/fhir/SearchParameter/InsurancePlan-administered-by SHOULD reference

InsurancePlan administered by
endpoint http://hl7.org/fhir/SearchParameter/InsurancePlan-endpoint SHOULD reference

InsurancePlan endpoint
identifier http://hl7.org/fhir/SearchParameter/InsurancePlan-identifier SHOULD token

InsurancePlan identifier
name http://hl7.org/fhir/SearchParameter/InsurancePlan-name SHOULD string

InsurancePlan name
owned-by http://hl7.org/fhir/SearchParameter/InsurancePlan-owned-by SHOULD reference

InsurancePlan owned by
status http://hl7.org/fhir/SearchParameter/InsurancePlan-status SHOULD token

InsurancePlan status
type http://hl7.org/fhir/SearchParameter/InsurancePlan-type SHOULD token

InsurancePlan type


Location

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  read SHALL

Read the current state of the resource
  vread SHALL

Read the state of a specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: Location:endpoint, Location:location-new-patient-from-network, Location:organization, Location:partof

Supported Reverse-Includes: CareTeam:careteam-location, HealthcareService:coverage-area, HealthcareService:location, InsurancePlan:insuranceplan-coverage-area, OrganizationAffiliation:location, PractitionerRole:location

Parameter Name Definition Conformance Type Description
location-accessibility LocationAccessibilitySearchParameter SHALL token

Location accessibility
location-contains LocationContainsSearchParameter SHALL special

Location contains
location-new-patient-from-network LocationNewPatientFromNetworkSearchParameter SHALL reference

Location new patient from network
location-new-patient LocationNewPatientSearchParameter SHALL token

Location new patient
_id http://hl7.org/fhir/SearchParameter/Resource-id SHALL token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHALL date

Allows filtering for only records that have changed since last query.
address http://hl7.org/fhir/SearchParameter/Location-address SHALL string

Location address
address-city http://hl7.org/fhir/SearchParameter/Location-address-city SHALL string

Location address-city
address-country http://hl7.org/fhir/SearchParameter/Location-address-country SHALL string

Location address-country
address-postalcode http://hl7.org/fhir/SearchParameter/Location-address-postalcode SHALL string

Location address-postalcode
address-state http://hl7.org/fhir/SearchParameter/Location-address-state SHALL string

Location address-state
address-use http://hl7.org/fhir/SearchParameter/Location-address-use SHALL token

Location address-use
organization http://hl7.org/fhir/SearchParameter/Location-organization SHALL reference

Location organization
type http://hl7.org/fhir/SearchParameter/Location-type SHALL token

Location type


Organization

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  read SHALL

Read the current state of the resource
  vread SHALL

Read the state of a specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: Organization:endpoint, Organization:organization-identifier-assigner, Organization:partof

Supported Reverse-Includes: CareTeam:careteam-organization, Endpoint:organization, Endpoint:endpoint-identifier-assigner, HealthcareService:organization, HealthcareService:healthcareservice-new-patient-from-network, HealthcareService:healthcareservice-network, InsurancePlan:administered-by, InsurancePlan:owned-by, InsurancePlan:insuranceplan-coverage-network, InsurancePlan:insuranceplan-plan-network, InsurancePlan:insuranceplan-network, Location:organization, Location:location-new-patient-from-network, OrganizationAffiliation:network, OrganizationAffiliation:participating-organization, OrganizationAffiliation:primary-organization, Practitioner:practitioner-identifier-assigner, Practitioner:practitioner-qualification-issuer, PractitionerRole:organization, PractitionerRole:practitionerrole-network, PractitionerRole:practitionerrole-new-patient-from-network

Parameter Name Definition Conformance Type Description
network-coverage-area NetworkCoverageAreaSearchParameter SHALL reference

Network coverage area
_id http://hl7.org/fhir/SearchParameter/Resource-id SHALL token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHALL date

Allows filtering for only records that have changed since last query.
active http://hl7.org/fhir/SearchParameter/Organization-active SHALL token

Organization active
address http://hl7.org/fhir/SearchParameter/Organization-address SHALL string

Organization address
address-city http://hl7.org/fhir/SearchParameter/Organization-address-city SHALL string

Organization address-city
address-country http://hl7.org/fhir/SearchParameter/Organization-address-country SHALL string

Organization address-country
address-postalcode http://hl7.org/fhir/SearchParameter/Organization-address-postalcode SHALL string

Organization address-postalcode
address-state http://hl7.org/fhir/SearchParameter/Organization-address-state SHALL string

Organization address-state
address-use http://hl7.org/fhir/SearchParameter/Organization-address-use SHALL token

Organization address-use
endpoint http://hl7.org/fhir/SearchParameter/Organization-endpoint SHALL reference

Organization endpoint
identifier http://hl7.org/fhir/SearchParameter/Organization-identifier SHALL token

Organization identifier
name http://hl7.org/fhir/SearchParameter/Organization-name SHALL string

Organization name
partof http://hl7.org/fhir/SearchParameter/Organization-partof SHALL reference

Organization partof
type http://hl7.org/fhir/SearchParameter/Organization-type SHALL token

Organization type


OrganizationAffiliation

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type
  read SHOULD

Read the current state of the resource
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  vread SHOULD

Read the state of specific version of the resource

Search

Supported Includes: OrganizationAffiliation:network, OrganizationAffiliation:participating-organization, OrganizationAffiliation:primary-organization

Parameter Name Definition Conformance Type Description
_id http://hl7.org/fhir/SearchParameter/Resource-id SHOULD token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHOULD date

Allows filtering for only records that have changed since last query.
endpoint http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-endpoint SHOULD reference

OrganizationAffiliation endpoint
identifier http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-identifier SHOULD token

OrganizationAffiliation identifier
location http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-location SHOULD reference

OrganizationAffiliation location
network http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-network SHOULD reference

OrganizationAffiliation network
participating-organization http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-participating-organization SHOULD reference

OrganizationAffiliation participating-organization
primary-organization http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-primary-organization SHOULD reference

OrganizationAffiliation primary-organization
role http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-role SHOULD token

OrganizationAffiliation role
service http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-service SHOULD reference

OrganizationAffiliation service
specialty http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-specialty SHOULD token

OrganizationAffiliation specialty


Practitioner

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  read SHALL

Read the current state of the resource
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  vread SHALL

Read the state of specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: Practitioner:practitioner-endpoint, Practitioner:practitioner-identifier-assigner, Practitioner:practitioner-qualification-issuer, Practitioner:practitione-via-intermediary, Practitioner:verification-attestation-who

Supported Reverse-Includes: PractitionerRole:practitioner

Parameter Name Definition Conformance Type Description
practitioner-qualification-issuer PractitionerQualificationIssuerSearchParameter SHALL reference

Practitioner qualification issuer
practitioner-qualification-code PractitionerQualificationCodeSearchParameter SHALL token

Practitioner qualification code
_id http://hl7.org/fhir/SearchParameter/Resource-id SHALL token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHALL date

Allows filtering for only records that have changed since last query.
active http://hl7.org/fhir/SearchParameter/Practitioner-active SHALL token

Whether this practitioner's record is in active use
name http://hl7.org/fhir/SearchParameter/Practitioner-name SHALL string

A portion of either family or given name of the practitioner
gender http://hl7.org/fhir/SearchParameter/individual-gender SHALL token

Practitioner gender
identifier http://hl7.org/fhir/SearchParameter/Practitioner-identifier SHALL token

A practitioner's Identifier


PractitionerRole

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  read SHALL

Read the current state of the resource
  search-type SHALL

Search all resources of the specified type based on some filter criteria.
  vread SHALL

Read the state of specific version of the resource
  history-instance SHALL

Retrieve the history of the resource
  history-type SHALL

Retrieve the history of the resource type

Search

Supported Includes: PractitionerRole:location, PractitionerRole:practitionerrole-network, PractitionerRole:practitionerrole-new-patient-from-network, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service

Parameter Name Definition Conformance Type Description
practitionerrole-network PractitionerroleNetworkSearchParameter SHALL reference

PractitionerRole network
practitionerrole-new-patient PractitionerroleNewPatientSearchParameter SHALL token

PractitionerRole new-patient
practitionerrole-new-patient-from-network PractitionerroleNewPatientFromNetworkSearchParameter SHALL reference

PractitionerRole new-patient from network
_id http://hl7.org/fhir/SearchParameter/Resource-id SHALL token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHALL date

Allows filtering for only records that have changed since last query.
active http://hl7.org/fhir/SearchParameter/PractitionerRole-active SHALL token

Whether this practitioner's record is in active use
identifier http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier SHALL token

A practitioner's Identifier
location http://hl7.org/fhir/SearchParameter/PractitionerRole-location SHALL reference

One of the locations at which this practitioner provides care
organization http://hl7.org/fhir/SearchParameter/PractitionerRole-organization SHALL reference

The identity of the organization the practitioner represents / acts on behalf of
practitioner http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner SHALL reference

Practitioner that is able to provide the defined services for the organization
role http://hl7.org/fhir/SearchParameter/PractitionerRole-role SHALL token

The practitioner can perform this role at for the organization
service http://hl7.org/fhir/SearchParameter/PractitionerRole-service SHALL reference

The list of healthcare services that this worker provides for this role's Organization/Location
specialty http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty SHALL token

The practitioner has this specialty at an organization


Consent

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  read SHOULD

Read the current state of the resource
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  vread SHOULD

Read the state of specific version of the resource
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type


VerificationResult

Supported Profile(s):

Behavior

Versioning support: versioned-update

Reference policy: literal, local

Interactions

Name Conformance Description
  read SHOULD

Read the current state of the resource
  search-type SHOULD

Search all resources of the specified type based on some filter criteria.
  vread SHOULD

Read the state of specific version of the resource
  history-instance SHOULD

Retrieve the history of the resource
  history-type SHOULD

Retrieve the history of the resource type

Search

Supported Includes: VerificationResult:verificationresult-target, VerificationResult:verificationresult-attestation-who

Parameter Name Definition Conformance Type Description
verificationresult-attestation-who VerificationResultAttestationWhoSearchParameter SHOULD reference

VerificationResult attestation who
verificationresult-primarysource-validation-status VerificationResultPrimarysourceValidationStatusSearchParameter SHOULD token

VerificationResult primarysource validation-status
verificationresult-primarysource-type VerificationResultPrimarysourceTypeSearchParameter SHOULD token

VerificationResult primarysource type
verificationresult-status VerificationResultStatusSearchParameter SHOULD token

VerificationResult status
verificationresult-target VerificationResultTargetSearchParameter SHOULD reference

VerificationResult target
_id http://hl7.org/fhir/SearchParameter/Resource-id SHOULD token

Logical id allows to retrive more than one in a single call
_lastUpdated http://hl7.org/fhir/SearchParameter/Resource-lastUpdated SHOULD date

Allows filtering for only records that have changed since last query.