{
  "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-12-12",
  "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",
  "status": "active",
  "id": "5ccefc96-4bba-42ea-85a4-7484de11ec3a",
  "kind": "requirements",
  "implementationGuide": [ "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",
  "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"
      } ]
    } ],
    "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 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"
    } ]
  } ]
}