PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.au.ereq@0.3.0-preview
    http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-patient
{
  "description": "This CapabilityStatement describes the basic rules for the [AU eRequesting Patient actor](ActorDefinition-au-erequesting-actor-patient.html) that is the digital interface that allows patients or their representatives to view diagnostic requests and fulfilment of diagnostic requests. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU eRequesting patient clients are defined in this CapabilityStatement.",
  "_filename": "CapabilityStatement-au-erequesting-patient.json",
  "package_name": "hl7.fhir.au.ereq",
  "format": [ "json", "xml" ],
  "_patchFormat": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "MAY"
    } ]
  } ],
  "_format": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "MAY"
    } ]
  }, {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "MAY"
    } ]
  } ],
  "date": "2025-03-12T04:23:30+00:00",
  "publisher": "HL7 Australia",
  "patchFormat": [ "application/json-patch+json" ],
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "AU",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "name": "AUeRequestingPatientCapabilityStatement",
  "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "title": "AU eRequesting Patient CapabilityStatement",
  "package_version": "0.3.0-preview",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 0
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "draft",
    "_valueCode": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org.au/fhir/ereq/ImplementationGuide/hl7.fhir.au.ereq"
      } ]
    }
  } ],
  "status": "draft",
  "id": "9fbd7301-768c-451c-bf02-84738f038aea",
  "kind": "requirements",
  "implementationGuide": [ "http://hl7.org.au/fhir/ImplementationGuide/hl7.fhir.au.base", "http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core" ],
  "url": "http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-patient",
  "version": "0.3.0-preview",
  "contact": [ {
    "name": "HL7 Australia",
    "telecom": [ {
      "value": "https://confluence.hl7.org/display/HAFWG",
      "system": "url"
    } ]
  }, {
    "name": "HL7 Australia FHIR Work Group",
    "telecom": [ {
      "use": "work",
      "value": "https://confluence.hl7.org/display/HAFWG",
      "system": "url"
    } ]
  } ],
  "rest": [ {
    "mode": "client",
    "resource": [ {
      "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": "requisition",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-requisition"
      } ],
      "type": "ServiceRequest",
      "interaction": [ {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "documentation": "Patients **SHALL** support the ServiceRequest resource, at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource.\n\nThe Patient **SHOULD** support the `_include` parameter for `ServiceRequest:patient`, `ServiceRequest:requester` and `ServiceRequest:encounter`.",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "supportedProfile": [ "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path", "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-imag" ],
      "_searchInclude": [ {
        "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"
        } ]
      } ],
      "searchInclude": [ "ServiceRequest:patient", "ServiceRequest:requester", "ServiceRequest:encounter" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ]
    }, {
      "type": "Coverage",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "documentation": "Patient clients **SHOULD** support the Coverage resource, the AU eRequesting profile, and the conformance expectations for the Coverage resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-coverage" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "Encounter",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "documentation": "Patient clients **SHOULD** support the Encounter resource, the AU Core profile, and the conformance expectations for the Encounter resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "Organization",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "documentation": "Patient clients **SHOULD** support the Organization resource, the AU Core profile, and the conformance expectations for the Organization resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "Patient",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      } ],
      "documentation": "If Patient supports the Patient resource, the AU Core Patient and Patient (IPS) profiles and the conformance expectations for the Patient resource **SHALL** be supported.",
      "supportedProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient", "http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "Practitioner",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "documentation": "Patient clients **SHOULD** support the Practitioner resource, the AU Core profile, and the conformance expectations for the Practitioner resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "PractitionerRole",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "documentation": "Patient clients **SHOULD** support the PractitionerRole resource, the AU Core profile, and the conformance expectations for the PractitionerRole resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "Condition",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ],
      "documentation": "Patient **MAY** support the Condition resource, the AU Core profile, and the conformance expectations for the Condition resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "DocumentReference",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ],
      "documentation": "Patient **MAY** support the DocumentReference resource.",
      "supportedProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ]
    }, {
      "type": "Location",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ],
      "documentation": "Patient **MAY** support the Location resource, the AU Core profile, and the conformance expectations for the Location resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-location" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "Observation",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      } ],
      "documentation": "If Patient supports the Observation resource, the Observation Pregnancy - Status (IPS), the Observation Pregnancy - Expected Delivery Date (IPS) profiles and the conformance expectations for the Observation resource **SHALL** be supported.",
      "supportedProfile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips", "http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-edd-uv-ips" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "Procedure",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ],
      "documentation": "Patient **MAY** support the Procedure resource, the AU Core profile, and the conformance expectations for the Procedure resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "RelatedPerson",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ],
      "documentation": "Patient **MAY** support the RelatedPerson resource, the AU Base profile, and the conformance expectations for the RelatedPerson resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/StructureDefinition/au-relatedperson" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "CommunicationRequest",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      } ],
      "documentation": "If the Patient supports the CommunicationRequest resource, the Patient **SHALL** support the AU eRequesting profiles and the conformance expectations for the CommunicationRequest resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest-copyto" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "Consent",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      } ],
      "documentation": "If the Patient supports the Consent resource, the Patient **SHALL** support the AU eRequesting profiles and the conformance expectations for the Consent resource.",
      "supportedProfile": [ "http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-mhrconsentwithdrawal" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    } ],
    "security": {
      "description": "None defined."
    },
    "documentation": "The AU eRequesting Patient **SHALL**:\n1. Support at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource. \n1. Implement the RESTful behavior according to the FHIR specification."
  } ],
  "_implementationGuide": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  }, {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  } ]
}