Generated Narrative: CapabilityStatement ndh-server Profile: CapabilityStatement NDH Server Capability Statement Implementation Guide Version: 2.0.0-current FHIR Version: 4.0.1 Supported Formats: xml, json Published on: 2022-11-01 Published by: HL7 International / Patient Administration Note to Implementers: FHIR Capabilities Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case. FHIR RESTful Capabilities Mode: server NDH Server Capabilities by Resource/Profile Summary The summary table lists the resources that are part of this configuration, and for each resource it lists: The relevant profiles (if any) The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them. The required, recommended, and some optional search parameters (if any). The linked resources enabled for _include The other resources enabled for _revinclude The operations on the resource (if any) Resource Type Profile R V-R S U C H-I H-T Searches _include _revinclude Operations Endpoint Supported Profiles NDH Endpoint Profile Y Y Y Y y? trust-framework-type, dynamic-registration-trust-profile, access-control-mechanism, ihe-connection-type, verification-status, connection-type, identifier, organization, status, _id, _lastUpdated Endpoint:organization HealthcareService:endpoint, InsurancePlan:endpoint, Location:endpoint, Organization:endpoint, OrganizationAffiliation:endpoint, Practitioner:endpoint, PractitionerRole:endpoint HealthcareService Supported Profiles NDH HealthcareService Profile Y Y Y Y y? new-patient-from-network, eligibility, new-patient, verification-status, location, organization, active, coverage-area, endpoint, identifier, name, program, service-category, service-type, specialty, _id, _lastUpdated HealthcareService:coverage-area, HealthcareService:endpoint, HealthcareService:location, HealthcareService:new-patient-from-network, HealthcareService:organization OrganizationAffiliation:service, PractitionerRole:service InsurancePlan Supported Profiles NDH InsurancePlan Profile Y Y Y Y y? coverage-area, coverage-benefit-type, coverage-type, coverage-network, network, plan-network, plan-type, verification-status, address, address-city, address-country, address-postalcode, address-state, administered-by, endpoint, identifier, name, owned-by, status, type, _id, _lastUpdated InsurancePlan:administered-by, InsurancePlan:endpoint, InsurancePlan:owned-by, InsurancePlan:coverage-area, InsurancePlan:coverage-network, InsurancePlan:plan-network, InsurancePlan:network Location Supported Profiles NDH Location Profile Y Y Y Y y? accessibility, contains, verification-status, address, address-city, address-country, address-postalcode, address-state, address-use, endpoint, identifier, name, near, partof, organization, type, _id, _lastUpdated Location:endpoint, Location:organization, Location:partof HealthcareService:coverage-area, HealthcareService:location, InsurancePlan:coverage-area, OrganizationAffiliation:location, PractitionerRole:location Organization Supported Profiles NDH Organization Profile NDH Network Profile Y Y Y Y y? coverage-area, verification-status, active, address, address-city, address-country, address-postalcode, address-state, address-use, endpoint, identifier, name, partof, type, _id, _lastUpdated Organization:endpoint, Organization:partof Endpoint:organization, HealthcareService:organization, HealthcareService:new-patient-from-network, InsurancePlan:administered-by, InsurancePlan:owned-by, InsurancePlan:coverage-network, InsurancePlan:plan-network, InsurancePlan:network, Location:organization, OrganizationAffiliation:network, OrganizationAffiliation:participating-organization, OrganizationAffiliation:primary-organization, Practitioner:qualification-issuer, PractitionerRole:organization, PractitionerRole:network OrganizationAffiliation Supported Profiles NDH OrganizationAffiliation Profile Y Y Y Y y? location, participating-organization, primary-organization, verification-status, endpoint, identifier, network, role, service, specialty, _id, _lastUpdated OrganizationAffiliation:network, OrganizationAffiliation:participating-organization, OrganizationAffiliation:primary-organization Practitioner Supported Profiles NDH Practitioner Profile Y Y Y Y y? endpoint, qualification-issuer, qualification-code, verification-status, active, name, gender, identifier, _id, _lastUpdated Practitioner:endpoint, Practitioner:qualification-issuer PractitionerRole:practitioner PractitionerRole Supported Profiles NDH PractitionerRole Y Y Y Y y? network, location, organization, verification-status, active, endpoint, identifier, practitioner, role, service, specialty, _id, _lastUpdated PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:network, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service VerificationResult Supported Profiles NDH Verification y? y? y? y? y? attestation-who, primarysource-validation-status, primarysource-type, status, target, _id, _lastUpdated VerificationResult:target, VerificationResult:attestation-who Group Supported Profiles NDH Group Y Y Y Y y? verification-status, member, managing-entity, type, code, _id, _lastUpdated Resource Conformance: SHALL Endpoint Core FHIR Resource Endpoint Reference Policy literal, local Interaction summary SHALL support search-type Search all resources of the specified type based on some filter criteria. read Read the current state of the resource vread Read the state of a specific version of the resource history-instance Retrieve the history of the resource MAY support history-type Retrieve the history of the resource type Supported Profiles NDH Endpoint Profile Documentation Endporint Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation SHALL trust-framework-type token Endpoint trust framework type SHALL dynamic-registration-trust-profile token Endpoint dynamic registration trust profile SHALL access-control-mechanism token Endpoint access control mechanism SHALL ihe-connection-type token Endpoint ihe connection type SHALL verification-status token verification status SHALL connection-type token Connection type SHALL identifier token Endpoint identifier SHALL organization reference Organization that manages the Endpoint SHALL status token Endpoint status SHALL _id token Logical id allows to retrieve more than one in a single call SHALL _lastUpdated date Allows filtering for only records that have changed since last query. Resource Conformance: SHALL HealthcareService Core FHIR Resource HealthcareService Reference Policy literal, local Interaction summary SHALL support search-type Search all resources of the specified type based on some filter criteria. read Read the current state of the resource vread Read the state of a specific version of the resource history-instance Retrieve the history of the resource MAY support history-type Retrieve the history of the resource type Supported Profiles NDH HealthcareService Profile Documentation HealthcareService Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation SHALL new-patient-from-network reference New patient from network SHALL eligibility token Eligibility SHALL new-patient token New patient SHALL verification-status token verification status SHALL location reference The location of the Healthcare Service SHALL organization reference The organization that provides this Healthcare Service SHALL active token Whether this HealthcareService record is in active use SHALL coverage-area reference Location service is inteded for/available to SHALL endpoint reference Technical endpoints providing access to services operated for the location SHALL identifier token External identifiers for this item SHALL name string A portion of the Healthcare service name SHALL program token One of the Program Names that categorize the service SHALL service-category token Service Category of the Healthcare Service SHALL service-type token The type of service provided by this healthcare service SHALL specialty token Specialties handled by the HealthcareService SHALL _id token Logical id allows to retrive more than one in a single call SHALL _lastUpdated date Allows filtering for only records that have changed since last query. Resource Conformance: SHOULD InsurancePlan Core FHIR Resource InsurancePlan Reference Policy literal, local Interaction summary SHOULD support search-type Search all resources of the specified type based on some filter criteria. read Read the current state of the resource vread Read the state of a specific version of the resource history-instance Retrieve the history of the resource MAY support history-type Retrieve the history of the resource type Supported Profiles NDH InsurancePlan Profile Documentation InsurancePlan Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation SHOULD coverage-area reference InsurancePlan coverage area SHOULD coverage-benefit-type token InsurancePlan coverage benefit type SHOULD coverage-type token InsurancePlan coverage type SHOULD coverage-network reference InsurancePlan coverage network SHOULD network reference InsurancePlan network SHOULD plan-network reference InsurancePlan plan network SHOULD plan-type token InsurancePlan plan type SHOULD verification-status token Verification status SHOULD address string InsurancePlan contact address SHOULD address-city string InsurancePlan contact address-city SHOULD address-country string InsurancePlan contact address-country SHOULD address-postalcode string InsurancePlan contact address-postalcode SHOULD address-state string InsurancePlan contact address-state SHOULD administered-by reference InsurancePlan administered by SHOULD endpoint reference InsurancePlan endpoint SHOULD identifier token InsurancePlan identifier SHOULD name string InsurancePlan name SHOULD owned-by reference InsurancePlan owned by SHOULD status token InsurancePlan status SHOULD type token InsurancePlan type SHOULD _id token Logical id allows to retrive more than one in a single call SHOULD _lastUpdated date Allows filtering for only records that have changed since last query. Resource Conformance: SHALL Location Core FHIR Resource Location Reference Policy literal, local Interaction summary SHALL support search-type Search all resources of the specified type based on some filter criteria. read Read the current state of the resource vread Read the state of a specific version of the resource history-instance Retrieve the history of the resource MAY support history-type Retrieve the history of the resource type Supported Profiles NDH Location Profile Documentation Location Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation SHALL accessibility token Location accessibility SHALL contains special Location contains SHALL verification-status token Verification status SHALL address string Location address SHALL address-city string Location address-city SHALL address-country string Location address-country SHALL address-postalcode string Location address-postalcode SHALL address-state string Location address-state SHALL address-use token Location address-use SHALL endpoint reference Location endpoint SHALL identifier token Location identifier SHALL name string Location name SHALL near special Location position SHALL partof reference Location partof SHALL organization reference Location organization SHALL type token Location type SHALL _id token Logical id allows to retrive more than one in a single call SHALL _lastUpdated date Allows filtering for only records that have changed since last query. Resource Conformance: SHALL Organization Core FHIR Resource Organization Reference Policy literal, local Interaction summary SHALL support search-type Search all resources of the specified type based on some filter criteria. read Read the current state of the resource vread Read the state of a specific version of the resource history-instance Retrieve the history of the resource MAY support history-type Retrieve the history of the resource type Supported Profiles NDH Organization Profile NDH Network Profile Documentation Organization Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation SHALL coverage-area reference network organization type is needed for searching network coverage area SHALL verification-status token Verification status SHALL active token Organization active SHALL address string Organization address SHALL address-city string Organization address-city SHALL address-country string Organization address-country SHALL address-postalcode string Organization address-postalcode SHALL address-state string Organization address-state SHALL address-use token Organization address-use SHALL endpoint reference Organization endpoint SHALL identifier token Organization identifier SHALL name string Organization name SHALL partof reference Organization partof SHALL type token Organization type SHALL _id token Logical id allows to retrive more than one in a single call SHALL _lastUpdated date Allows filtering for only records that have changed since last query. Resource Conformance: SHALL OrganizationAffiliation Core FHIR Resource OrganizationAffiliation Reference Policy literal, local Interaction summary SHALL support history-instance Retrieve the history of the resource read Read the current state of the resource search-type Search all resources of the specified type based on some filter criteria. vread Read the state of specific version of the resource MAY support history-type Retrieve the history of the resource type Supported Profiles NDH OrganizationAffiliation Profile Documentation OrganizationAffiliation Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation SHALL location reference OrganizationAffiliation location SHALL participating-organization reference OrganizationAffiliation participating-organization SHALL primary-organization reference OrganizationAffiliation primary-organization SHALL verification-status token Verification status SHALL endpoint reference OrganizationAffiliation endpoint SHALL identifier token OrganizationAffiliation identifier SHALL network reference OrganizationAffiliation network SHALL role token OrganizationAffiliation role SHALL service reference OrganizationAffiliation service SHALL specialty token OrganizationAffiliation specialty SHALL _id token Logical id allows to retrive more than one in a single call SHALL _lastUpdated date Allows filtering for only records that have changed since last query. Resource Conformance: SHALL Practitioner Core FHIR Resource Practitioner Reference Policy literal, local Interaction summary SHALL support read Read the current state of the resource search-type Search all resources of the specified type based on some filter criteria. vread Read the state of specific version of the resource history-instance Retrieve the history of the resource MAY support history-type Retrieve the history of the resource type Supported Profiles NDH Practitioner Profile Documentation Practitioner Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation SHALL endpoint reference Practitioner endpoint SHALL qualification-issuer reference Practitioner qualification issuer SHALL qualification-code token Practitioner qualification code SHALL verification-status token Verification status SHALL active token Whether this practitioner's record is in active use SHALL name string A portion of either family or given name of the practitioner SHALL gender token Practitioner gender SHALL identifier token A practitioner's Identifier SHALL _id token Logical id allows to retrive more than one in a single call SHALL _lastUpdated date Allows filtering for only records that have changed since last query. Resource Conformance: SHALL PractitionerRole Core FHIR Resource PractitionerRole Reference Policy literal, local Interaction summary SHALL support read Read the current state of the resource search-type Search all resources of the specified type based on some filter criteria. vread Read the state of specific version of the resource history-instance Retrieve the history of the resource MAY support history-type Retrieve the history of the resource type Supported Profiles NDH PractitionerRole Documentation PractitionerRole Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation SHALL network reference PractitionerRole network SHALL location reference One of the locations at which this practitioner provides care SHALL organization reference The identity of the organization the practitioner represents / acts on behalf of SHALL verification-status token Verification status SHALL active token Whether this practitioner's record is in active use SHALL endpoint reference Technical endpoints providing access to services operated for the practitioner with this role SHALL identifier token A practitioner's Identifier SHALL practitioner reference Practitioner that is able to provide the defined services for the organization SHALL role token The practitioner can perform this role at for the organization SHALL service reference The list of healthcare services that this worker provides for this role's Organization/Location SHALL specialty token The practitioner has this specialty at an organization SHALL _id token Logical id allows to retrive more than one in a single call SHALL _lastUpdated date Allows filtering for only records that have changed since last query. Resource Conformance: MAY VerificationResult Core FHIR Resource VerificationResult Reference Policy literal, local Interaction summary MAY support read Read the current state of the resource search-type Search all resources of the specified type based on some filter criteria. vread Read the state of specific version of the resource history-instance Retrieve the history of the resource history-type Retrieve the history of the resource type Supported Profiles NDH Verification Documentation Verification Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation MAY attestation-who reference VerificationResult attestation who MAY primarysource-validation-status token VerificationResult primarysource validation-status MAY primarysource-type token VerificationResult primarysource type MAY status token VerificationResult status MAY target reference VerificationResult target MAY _id token Logical id allows to retrive more than one in a single call MAY _lastUpdated date Allows filtering for only records that have changed since last query. Resource Conformance: SHOULD Group Core FHIR Resource Group Reference Policy literal, local Interaction summary SHOULD support read Read the current state of the resource search-type Search all resources of the specified type based on some filter criteria. vread Read the state of specific version of the resource history-instance Retrieve the history of the resource MAY support history-type Retrieve the history of the resource type Supported Profiles NDH Group Documentation Group Resource, supportedProfile, interaction, search parameter Search Parameters Conformance Parameter Type Documentation SHOULD verification-status token Verification status SHOULD member reference Group member SHOULD managing-entity reference Group managing entity SHOULD type token Group type SHOULD code token Group code SHOULD _id token Logical id allows to retrieve more than one in a single call SHOULD _lastUpdated date Allows filtering for only records that have changed since last query.
HL7 International / Patient Administration
This Section describes the expected capabilities of the NDH Server 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.
Endporint Resource, supportedProfile, interaction, search parameter
Search all resources of the specified type based on some filter criteria.
Read the state of a specific version of the resource
Retrieve the history of the resource type
Endpoint dynamic registration trust profile
Logical id allows to retrieve more than one in a single call
Allows filtering for only records that have changed since last query.
HealthcareService Resource, supportedProfile, interaction, search parameter
The organization that provides this Healthcare Service
Whether this HealthcareService record is in active use
Location service is inteded for/available to
Technical endpoints providing access to services operated for the location
A portion of the Healthcare service name
One of the Program Names that categorize the service
Service Category of the Healthcare Service
The type of service provided by this healthcare service
Specialties handled by the HealthcareService
Logical id allows to retrive more than one in a single call
InsurancePlan Resource, supportedProfile, interaction, search parameter
InsurancePlan contact address-postalcode
Location Resource, supportedProfile, interaction, search parameter
Organization Resource, supportedProfile, interaction, search parameter
network organization type is needed for searching network coverage area
OrganizationAffiliation Resource, supportedProfile, interaction, search parameter
Read the state of specific version of the resource
OrganizationAffiliation participating-organization
OrganizationAffiliation primary-organization
Practitioner Resource, supportedProfile, interaction, search parameter
Whether this practitioner's record is in active use
A portion of either family or given name of the practitioner
PractitionerRole Resource, supportedProfile, interaction, search parameter
One of the locations at which this practitioner provides care
The identity of the organization the practitioner represents / acts on behalf of
Technical endpoints providing access to services operated for the practitioner with this role
Practitioner that is able to provide the defined services for the organization
The practitioner can perform this role at for the organization
The list of healthcare services that this worker provides for this role's Organization/Location
The practitioner has this specialty at an organization
Verification Resource, supportedProfile, interaction, search parameter
VerificationResult primarysource validation-status
Group Resource, supportedProfile, interaction, search parameter