{
  "description": "CapabilityStatement for Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE FHIR Scheduling. See https://profiles.ihe.net/ITI/TF/Volume1/ch-38.html.",
  "_filename": "CapabilityStatement-IHE.Scheduling.client.json",
  "package_name": "ihe.iti.scheduling",
  "format": [ "application/fhir+xml", "application/fhir+json" ],
  "_format": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  }, {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHOULD"
    } ]
  } ],
  "date": "2024-02-05",
  "publisher": "IHE IT Infrastructure Technical Committee",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
    } ]
  } ],
  "name": "IHE_Scheduling_Client",
  "copyright": "IHE http://www.ihe.net/Governance/#Intellectual_Property",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "IHE Scheduling Client",
  "package_version": "1.0.0-comment",
  "status": "active",
  "id": "df5a6ee2-b802-4c4b-b4f6-581d4734894f",
  "kind": "requirements",
  "implementationGuide": [ "http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch", "http://hl7.org/fhir/uv/ipa/ImplementationGuide/hl7.fhir.uv.ipa", "https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp" ],
  "url": "https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.client",
  "version": "1.0.0-comment",
  "contact": [ {
    "telecom": [ {
      "value": "https://www.ihe.net/ihe_domains/it_infrastructure/",
      "system": "url"
    } ]
  }, {
    "telecom": [ {
      "value": "iti@ihe.net",
      "system": "email"
    } ]
  }, {
    "name": "IHE IT Infrastructure Technical Committee",
    "telecom": [ {
      "value": "iti@ihe.net",
      "system": "email"
    } ]
  } ],
  "rest": [ {
    "mode": "client",
    "resource": [ {
      "type": "Appointment",
      "profile": "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt",
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "date"
        } ]
      } ],
      "operation": [ {
        "name": "find",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find",
        "documentation": "Document the find operation"
      }, {
        "name": "book",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book",
        "documentation": "Document the book operation"
      }, {
        "name": "hold",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-hold",
        "documentation": "Document the hold operation"
      } ],
      "interaction": [ {
        "code": "read"
      }, {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
        "documentation": "Logical id of this artifact"
      }, {
        "name": "identifier",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
        "documentation": "The client **SHALL** provide both the system and code values."
      }, {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Appointment-patient",
        "documentation": "The patient, or one of the patients, for whom this apointement exists"
      }, {
        "name": "date",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
        "documentation": "The date, or date range, for the appointments being searched."
      }, {
        "name": "specialty",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Appointment-specialty",
        "documentation": "The specialty for which the appointments being searched is."
      }, {
        "name": "appointment-type",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Appointment-appointment-type"
      }, {
        "name": "practitioner",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Appointment-practitioner",
        "documentation": "The provider, or one of the providers, with whom this apointement is scheduled"
      } ]
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      }, {
        "name": "birthdate",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
        "documentation": "A client **SHALL** provide a value precise to the *day*."
      }, {
        "name": "family",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/individual-family"
      }, {
        "name": "gender",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
        "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both."
      }, {
        "name": "given",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/individual-given"
      }, {
        "name": "identifier",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
        "documentation": "The client **SHALL** provide both the system and code values."
      }, {
        "name": "name",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Patient-name"
      } ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "Patient",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "documentation": "Client applications SHALL be able to access the patient record using the following API call:\n\n`GET [url]/Patient/[id]`\n\nClient application MAY use these search parameters that servers are required to support to access the patient record:\n\n - `_id`\n - `identifier`\n\nServers are not required to support any additional search parameters, and clients SHOULD not expect servers to do so.\n\nAdditional rules and guidance for supporting `Patient.link`:\n\n- The server:\n    - SHALL have no more than one Patient with a status of active = \"true\" *from the server being queried* \n    - MAY include inactive patients on the *same server*\n    - MAY include inactive or active patients from a *different server*\n    - When returning a [search Bundle](http://hl7.org/fhir/bundle.html) that contains more than one Patient record for the same patient, the Patient record(s) SHALL use the `Patient.link` attribute to cross-link the Patient resources.\n- The client:\n    - SHALL be able to follow the link(s) to the other Patient resource(s) and understand the direction of the link (in other words, which Patient is linked to which other Patient)\n    - SHALL understand the `Patient.link.type` code which defines the type of link between this Patient resource and another Patient resource\n    - SHALL be aware of the linked Patient `active` flag and that inactive patients could have relevant information",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "family"
        }, {
          "url": "required",
          "valueString": "gender"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "birthdate"
        }, {
          "url": "required",
          "valueString": "family"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "birthdate"
        }, {
          "url": "required",
          "valueString": "name"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "gender"
        }, {
          "url": "required",
          "valueString": "name"
        } ]
      } ],
      "conditionalCreate": false,
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient",
      "conditionalDelete": "not-supported"
    } ],
    "security": {
      "cors": false,
      "description": "None mandated by IHE, encouraged IHE-IUA or SMART-on-FHIR"
    },
    "interaction": [ {
      "code": "search-system"
    } ],
    "documentation": "IHE Scheduling client will \r\n1. query for Patient resources matching the IPA Patient resource query parameters, \r\n1. query for Appointment resources matching the IHE Scheduling Appointment resource query parameters,\r\n1. use the operations defined for the Appointment resource"
  } ],
  "_implementationGuide": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHOULD"
    } ]
  }, {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHOULD"
    } ]
  }, {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHOULD"
    } ]
  } ]
}