New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: CapabilityStatement - XML Representation

Raw xml | Download

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="HpiCapabilityStatement"/>
  <text>
    <status value="additional"/>
    <div xmlns="http://www.w3.org/1999/xhtml">HPI capabilities</div>
  </text>
  <url
       value="http://hl7.org.nz/fhir/ig/hpi/CapabilityStatement/HpiCapabilityStatement"/>
  <version value="0.9.0"/>
  <name value="HPI_CapabilityStatement"/>
  <title value="Capability Statement describing HPI FHIR APIs"/>
  <status value="draft"/>
  <date value="2020-04-01"/>
  <publisher value="Ministry of Health"/>
  <contact>
    <name value="Ministry of Health"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:integration@health.govt.nz"/>
    </telecom>
  </contact>
  <description
               value="This is the computable resource that describes the RESTful endpoint"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="NZ"/>
    </coding>
  </jurisdiction>
  <kind value="instance"/>
  <implementation>
    <description value="The HPI endpoint"/>
    <url value="https://api.hip.digital.health.nz/fhir/hpi/v1/"/>
  </implementation>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <rest>
    <mode value="server"/>
    <resource>
      <type value="Practitioner"/>
      <supportedProfile
                        value="http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner"/>
      <documentation value="Practitioner query
"/>
      <interaction>
        <code value="read"/>
        <documentation value="Used to retrieve a Practitioner resource by Id."/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation value="Not case sensitive"/>
      </searchParam>
      <searchParam>
        <name value="family"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="given"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <name value="gender"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <name value="birthdate"/>
        <type value="date"/>
        <documentation value="Supports a search on practitioner birthdate"/>
      </searchParam>
    </resource>
    <resource>
      <type value="PractitionerRole"/>
      <supportedProfile
                        value="http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role"/>
      <documentation value="PractitionerRole query
"/>
      <interaction>
        <code value="read"/>
        <documentation
                       value="Used to retrieve a PractitionerRole resource by Id."/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="create"/>
        <documentation value="Create a new PractitionerRole"/>
      </interaction>
      <interaction>
        <code value="update"/>
        <documentation value="Update an existing PractitionerRole"/>
      </interaction>
      <searchInclude value="practitioner"/>
      <searchInclude value="organization"/>
      <searchInclude value="location"/>
      <searchParam>
        <name value="practitioner"/>
        <type value="reference"/>
        <documentation
                       value="Given a Practitioner id, returns the PractitionerRoles associated with that id"/>
      </searchParam>
      <searchParam>
        <name value="organization"/>
        <type value="reference"/>
        <documentation
                       value="Given a Organization id, returns the PractitionerRoles associated with that id"/>
      </searchParam>
      <searchParam>
        <name value="location"/>
        <type value="token"/>
        <documentation
                       value="Given a Location id, returns the PractitionerRoles associated with that id"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="Returns PractitionerRoles based on identifier"/>
      </searchParam>
      <searchParam>
        <name value="role"/>
        <type value="token"/>
        <documentation value="Returns PractitionerRoles based on role"/>
      </searchParam>
      <searchParam>
        <name value="active"/>
        <type value="token"/>
        <documentation value="To enable exclusion of inactive PractitionerRoles"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Organization"/>
      <supportedProfile
                        value="http://hl7.org.nz/fhir/StructureDefinition/hpi-organization"/>
      <documentation value="Organization query
"/>
      <interaction>
        <code value="read"/>
        <documentation value="Used to retrieve an Organization resource by Id."/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="active"/>
        <type value="token"/>
        <documentation value="To enable exclusion of inactive organizations"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation value="Will only return active organizations"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation
                       value="The HPI Organization id or the New Zealand Business Number (NZBN)."/>
      </searchParam>
      <searchParam>
        <name value="partOf"/>
        <type value="reference"/>
        <documentation
                       value="Locates Organizations that are &#39;part of&#39; another. "/>
      </searchParam>
    </resource>
    <resource>
      <type value="Location"/>
      <supportedProfile
                        value="http://hl7.org.nz/fhir/StructureDefinition/hpi-location"/>
      <documentation value="Location query
"/>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="Retrieve the Location with the identifier"/>
      </searchParam>
      <searchParam>
        <name value="name"/>
        <type value="string"/>
        <documentation
                       value="Retrieve the Locations with the matching name or alias"/>
      </searchParam>
      <searchParam>
        <name value="type"/>
        <type value="token"/>
        <documentation value="Retrieve Locations of the given type"/>
      </searchParam>
      <searchParam>
        <name value="address"/>
        <type value="string"/>
        <documentation value="Retrieve the Locations by address"/>
      </searchParam>
      <searchParam>
        <name value="organization"/>
        <type value="reference"/>
        <documentation value="Locations with the given ManagingOrganization"/>
      </searchParam>
      <searchParam>
        <name value="dhb"/>
        <type value="token"/>
        <documentation
                       value="Locations that are in a DHBs catchment area. This is a custom search"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <type value="token"/>
        <documentation value="The current status of the Location"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>