{
  "description": "This  CapabilityStatement describes the basic rules for the International Patient Access client actor that initiates a data access request to and retrieves patient data from an IPA Responder. In addition, it lists the client conformance expectations for each resource type documented in IPA. These expectations include supported FHIR profiles, RESTful operations, and search parameters. International Patient Access clients define their capabilities by choosing from this list based on the resource types they need to access.",
  "_filename": "CapabilityStatement-ipa-client.json",
  "package_name": "hl7.fhir.uv.ipa",
  "format": [ "json", "xml" ],
  "_patchFormat": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHOULD"
    } ]
  } ],
  "_format": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  }, {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHOULD"
    } ]
  } ],
  "date": "2023-11-14",
  "publisher": "HL7 International / Patient Care",
  "patchFormat": [ "application/json-patch+json" ],
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "World"
    } ]
  } ],
  "name": "InternationalPatientAccessClientAPI",
  "copyright": "Used by permission of HL7 International all rights reserved Creative Commons License",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "International Patient Access Client CapabilityStatement",
  "package_version": "1.1.0",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode": "pc"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "trial-use"
  } ],
  "status": "active",
  "id": "fe4e3f4e-a331-4b46-9395-33fbbe359006",
  "kind": "requirements",
  "implementationGuide": [ "http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch" ],
  "url": "http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-client",
  "version": "1.1.0",
  "contact": [ {
    "name": "HL7 International / Patient Care",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/patientcare",
      "system": "url"
    }, {
      "value": "patientcare@lists.HL7.org",
      "system": "email"
    } ]
  } ],
  "rest": [ {
    "mode": "client",
    "resource": [ {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "clinical-status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
        "documentation": "active | inactive | resolved"
      }, {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
        "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
      } ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "AllergyIntolerance",
      "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": "If the client supports the AllergyIntolerance resource, the client **SHALL** support the IPA profile and the conformance expectations for the AllergyIntolerance resource.",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "clinical-status"
        } ]
      } ],
      "conditionalCreate": false,
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance",
      "conditionalDelete": "not-supported"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "category",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Condition-category",
        "documentation": "The category of the condition"
      }, {
        "name": "clinical-status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
        "documentation": "The clinical status of the condition"
      }, {
        "name": "verification-status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Condition-verification-status",
        "documentation": "The verification status of the condition"
      }, {
        "name": "code",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
        "documentation": "Code for the condition"
      }, {
        "name": "onset-date",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-date",
        "documentation": "Date of onset for the condition"
      }, {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
        "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
      } ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "Condition",
      "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": "If the client supports the Condition resource, the client **SHALL** support the IPA profile and the conformance expectations for the Condition resource.\n\n Client applications should be prepared to encounter codes they do not recognize and handle the records \naccordingly. Servers SHOULD populate Condition.code.coding.display and/or Condition.code.text so that \nclients can always at least display the condition even if they do not know the codes that are used. Clients should be careful making use of the ```code``` search parameter given that the codes used vary so much.\n\nSafety Issues:\n\n* Clients SHALL not treat all conditions as if they are part of the patient's current problem list\n    * Note that some Condition resources may not have these status codes - this is usually due to poor record keeping reflected in legacy data\n    * Servers SHOULD avoid leaving these status codes missing\n* Clients SHALL pay attention to the ```clinicalStatus``` and ```verificationStatus``` and display and process them correctly * Clients SHALL still work safely when the server does not support all the search parameters listed here.",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "clinical-status"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "category"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "category"
        }, {
          "url": "required",
          "valueString": "clinical-status"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "code"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "onset-date"
        } ]
      } ],
      "conditionalCreate": false,
      "supportedProfile": [ "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-problem-list-item" ],
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition",
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "conditionalDelete": "not-supported"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      }, {
        "name": "category",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
        "documentation": "Categorization of document"
      }, {
        "name": "contenttype",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
        "documentation": "Mime type of the content, may include charset"
      }, {
        "name": "date",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
        "documentation": "When this document reference was created"
      }, {
        "name": "period",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
        "documentation": "Time of service that is being documented"
      }, {
        "name": "status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
        "documentation": "current | superseded | entered-in-error"
      }, {
        "name": "type",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
        "documentation": "Kind of document (LOINC if possible)"
      }, {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
        "documentation": "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
      } ],
      "conditionalUpdate": false,
      "operation": [ {
        "name": "docref",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/uv/ipa/OperationDefinition/docref",
        "documentation": "A client **SHOULD** be capable of transacting a $docref operation and capable of accessing the document using the using the link provided in the `DocumentReference.content.attachment.url` element."
      } ],
      "referencePolicy": [ "resolves" ],
      "type": "DocumentReference",
      "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": "If the client supports the DocumentReference resource, the client **SHALL** support the IPA profile and the conformance expectations for the DocumentReference resource.",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "category"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "category"
        }, {
          "url": "required",
          "valueString": "date"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "type"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "contenttype"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "status"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "type"
        }, {
          "url": "required",
          "valueString": "date"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "type"
        }, {
          "url": "required",
          "valueString": "period"
        } ]
      } ],
      "conditionalCreate": false,
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference",
      "conditionalDelete": "not-supported"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "date",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
        "documentation": "Vaccination  (non)-Administration Date"
      }, {
        "name": "status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Immunization-status",
        "documentation": "Immunization event status"
      }, {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
        "documentation": "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
      } ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "Immunization",
      "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": "If the client supports the Immunization resource, the client **SHALL** support the IPA profile and the conformance expectations for the Immunization resource.",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "date"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "status"
        } ]
      } ],
      "conditionalCreate": false,
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization",
      "conditionalDelete": "not-supported"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "Medication",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "documentation": "If the client supports the the MedicationStatement or MedicationRequest resource, the client **SHALL** support the IPA profile and the conformance expectations for the Medication resource.",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "conditionalCreate": false,
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication",
      "conditionalDelete": "not-supported"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "category",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-category",
        "documentation": "Returns prescriptions with different categories"
      }, {
        "name": "code",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
        "documentation": "Return prescriptions of this medication code"
      }, {
        "name": "authoredon",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
        "documentation": "Returns prescriptions written on this date"
      }, {
        "name": "intent",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent",
        "documentation": "Return prescriptions with this encounter identifier"
      }, {
        "name": "status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/medications-status",
        "documentation": "Status of the prescription"
      }, {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
        "documentation": "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
      } ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "MedicationRequest",
      "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": "If the client supports the MedicationRequest resource, the client **SHALL** support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.\n\n\nClients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.\n\n\nThe MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the `_include` parameter for searching this element. The client application **SHALL** support all methods. For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\n\n\n\n `GET /MedicationStatement?patient=[id]`\n\n\n\n `GET\n/MedicationStatement?patient=[id]&_include=MedicationStatement:medication`\n\n\nWhen representing a prescribed medication, servers SHOULD use codings at the level of a clinical drug rather than ingredient or dose form (e.g. \"loratadine 10mg oral tablet\", rather than a bare ingredient like \"loratadine\" or a dose form like \"loratadine oral tablet\").",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "intent"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "intent"
        }, {
          "url": "required",
          "valueString": "authoredon"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "intent"
        }, {
          "url": "required",
          "valueString": "status"
        } ]
      } ],
      "conditionalCreate": false,
      "searchInclude": [ "MedicationRequest:medication" ],
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest",
      "conditionalDelete": "not-supported"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/medications-status",
        "documentation": "Return statements that match the given status"
      }, {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
        "documentation": "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values."
      } ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "MedicationStatement",
      "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": "If the client supports the MedicationStatement resource, the client **SHALL** support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.\n\n\nClients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.\n\n\nThe MedicationStatement resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the `_include` parameter for searching this element. The client application **SHALL** support all methods.For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\n\n\n\n `GET /MedicationStatement?patient=[id]`\n\n\n\n `GET/MedicationStatement?patient=[id]&_include=MedicationStatement:medication`",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "status"
        } ]
      } ],
      "conditionalCreate": false,
      "searchInclude": [ "MedicationStatement:medication" ],
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement",
      "conditionalDelete": "not-supported"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "category",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Observation-category",
        "documentation": "The classification of the type of observation"
      }, {
        "name": "code",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
        "documentation": "The code of the observation type"
      }, {
        "name": "date",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
        "documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
      }, {
        "name": "status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Observation-status",
        "documentation": "The status of the observation"
      }, {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
        "documentation": "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
      } ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "Observation",
      "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": "If the client supports the Observation resource, the client **SHALL** support the IPA profile and the conformance expectations for the Observation resource.",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "category"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "code"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "category"
        }, {
          "url": "required",
          "valueString": "date"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "category"
        }, {
          "url": "required",
          "valueString": "status"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "code"
        }, {
          "url": "required",
          "valueString": "date"
        } ]
      } ],
      "conditionalCreate": false,
      "supportedProfile": [ "http://hl7.org/fhir/StructureDefinition/vitalsigns" ],
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation",
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "conditionalDelete": "not-supported"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "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*. A server **SHALL** support a value 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": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
        "documentation": "The client **SHALL** provide both the system and code values. The server **SHALL NOT** support only 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 may 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"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "Practitioner",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "documentation": "If the client supports the Practitioner resource, the client **SHALL** support the IPA profile and the conformance expectations for the Practitioner resource.",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "conditionalCreate": false,
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner",
      "conditionalDelete": "not-supported"
    }, {
      "searchRevInclude": [ "Provenance:target" ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "PractitionerRole",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "documentation": "If the client supports the PractitionerRole resource, the client **SHALL** support the IPA profile and the conformance expectations for the PractitionerRole resource.",
      "updateCreate": false,
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "conditionalCreate": false,
      "searchInclude": [ "PractitionerRole:endpoint", "PractitionerRole:practitioner" ],
      "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole",
      "conditionalDelete": "not-supported"
    } ],
    "security": {
      "description": "1. See the [General Security Considerations](security.html) section for requirements and recommendations."
    },
    "interaction": [ {
      "code": "transaction",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ]
    }, {
      "code": "batch",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ]
    }, {
      "code": "search-system",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ]
    }, {
      "code": "history-system",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ]
    } ],
    "documentation": "The IPA Client **SHALL**:\n1. Support the IPA conformance expectations for the Patient resource profile.\n1. Support the IPA conformance expectations for each IPA resource type they support\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Support JSON source formats for all IPA interactions.\n\n\nThe IPA Client **SHOULD**:\n1. For the purposes of safety, specify the patient id when searching other resources."
  } ],
  "_implementationGuide": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  } ]
}