adi
type: CapabilityStatement
node role: treeRoot
id:
  v: adi
text:
  status:
    v: generated
  div: ADI CapabilityStatement Implementation Guide Version: 0.0.1 FHIR Version: 4.0.1 Supported formats: xml, json Published: 2023-11-09 Published by: HL7 Patient Empowerment Working Group (PE WG) This Section describes the expected capabilities of the PACIO Advance Directive Interoperability (ADI) Server actor which is responsible for providing responses to the queries submitted by the ADI Requestors. There are two primary vehicles in which Advance Directive Information can be conveyed: DocumentReference and Bundle. Through a DocumentReference, the ADI may be encoded inside directly as content data or referred to through a content reference (pointing to the ADI included in a resource like Binary) or reference a Bundle with the type=document for FHIR encoded data. The resources referred to by the Composition in the document bundle include Patient, Observation, Goal, ServiceRequest, Organization, RelatedPerson, Consent, List, and Provenance. FHIR RESTful Capabilities The ADI Server SHALL: Support all profiles defined in this Implementation Guide. Implement the RESTful behavior according to the FHIR specification. Return the following response classes: (Status 400): invalid parameter (Status 401/4xx): unauthorized request (Status 403): insufficient scope (Status 404): unknown resource (Status 410): deleted resource. Support json source formats for all ADI interactions. Support the searchParameters on each profile individually and in combination. The ADI Server SHOULD: Support xml source formats for all ADI interactions. Security: See the Guidance section for requirements and recommendations. A server SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" response code. RESTful Capabilities by Resource/Profile: Summary of Search Criteria Resource Type Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations Bundle _id, composition, identifier, timestamp, type C…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
  value: code
    v: pe
url:
  v: http://hl7.org/fhir/us/pacio-adi/CapabilityStatement/adi
version:
  v: 2.0.0-ballot
name:
  v: PacioAdiCapabilityStatement
title:
  v: ADI CapabilityStatement
status:
  v: active
experimental:
  v: false
date:
  v: 2023-11-10
publisher:
  v: HL7 International / Patient Empowerment
contact:
  name:
    v: HL7 International / Patient Empowerment
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/patientempowerment
  telecom:
    system:
      v: email
description:
  v: This Section describes the expected capabilities of the PACIO Advance Directive Interoperability (ADI) Server actor which is responsible for providing responses to the queries submitted by the ADI Requestors. There are two primary vehicles in which Advance Directive Information can be conveyed: DocumentReference and Bundle. Through a DocumentReference, the ADI may be encoded inside directly as content data or referred to through a content reference (pointing to the ADI included in a resource like Binary) or reference a Bundle with the type=document for FHIR encoded data. The resources referred to by the Composition in the document bundle include Patient, Observation,Goal, ServiceRequest, Organization, RelatedPerson, Consent, List, and Provenance.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: US
    display:
      v: United States of America
kind:
  v: requirements
fhir version:
  v: 4.0.1
format:
  v: xml
format:
  v: json
patch format:
  v: application/json-patch+json
implementation guide:
  v: http://hl7.org/fhir/us/pacio-adi/ImplementationGuide/hl7.fhir.us.pacio-adi
  link: http://hl7.org/fhir/us/pacio-adi/ImplementationGuide/hl7.fhir.us.pacio-adi
rest:
  mode:
    v: server
  documentation:
    v: The ADI Server **SHALL**: 1. Support all profiles defined in this Implementation Guide. 2. Implement the RESTful behavior according to the FHIR specification. 3. Return the following response classes: - (Status 400): invalid parameter - (Status 401/4xx): unauthorized request - (Status 403): insufficient scope - (Status 404): unknown resource - (Status 410): deleted resource. 4. Support json source formats for all ADI interactions. 5. Support the searchParameters on each profile individually and in combination. The ADI Server **SHOULD**: 1. Support xml source formats for all ADI interactions.
  security:
    description:
      v: 1. See the [Guidance](security_privacy_consent.html) section for requirements and recommendations. 1. A server **SHALL** reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" response code.
  resource:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: SHALL
    type:
      v: Bundle
    interaction:
      extension:
        value: code
      code:
        v: create
    interaction:
      extension:
        value: code
      code:
        v: search-type
    interaction:
      extension:
        value: code
      code:
        v: read
    interaction:
      extension:
        value: code
      code:
        v: vread
    interaction:
      extension:
        value: code
      code:
        v: update
    interaction:
      extension:
        value: code
      code:
        v: history-instance
    reference policy:
      v: resolves
    search param:
      extension:
        value: code
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
    search param:
      extension:
        value: code
      name:
        v: composition
      definition:
        v: http://hl7.org/fhir/SearchParameter/Bundle-composition
        link: http://hl7.org/fhir/SearchParameter/Bundle-composition
      type:
        v: reference
    search param:
      extension:
        value: code
      name:
        v: identifier
      definition:
        v: http://hl7.org/fhir/SearchParameter/Bundle-identifier
        link: http://hl7.org/fhir/SearchParameter/Bundle-identifier
      type:
        v: token
    search param:
      extension:
        value: code
      name:
        v: timestamp
      definition:
        v: http://hl7.org/fhir/SearchParameter/Bundle-timestamp
        link: http://hl7.org/fhir/SearchParameter/Bundle-timestamp
      type:
        v: date
    search param:
      extension:
        value: code
      name:
        v: type
      definition:
        v: http://hl7.org/fhir/SearchParameter/Bundle-type
        link: http://hl7.org/fhir/SearchParameter/Bundle-type
      type:
        v: token
  resource:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      value: code
        v: MAY
    type:
      v: Composition
    supported profile:
      v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Composition-Header|2.0.0-ballot
      link: 2.0
      link: .0
    supported profile:
      v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-PACPComposition|2.0.0-ballot
      link: 2.0
      link: .0
    interaction:
      extension:
        value: code
      code:
        v: create
    interaction:
      extension:
        value: code
      code:
        v: search-type
    interaction:
      extension:
        value: code
      code:
        v: read
    interaction:
      extension:
        value: code
      code:
        v: vread
    interaction:
      extension:
        value: code
      code:
        v: update

code
v: SHALL

code
v: SHOULD

code
v: SHALL

code
v: SHOULD

code
v: SHALL

code
v: SHOULD

code
v: SHOULD

code
v: SHOULD

code
v: SHOULD

code
v: SHOULD

code
v: SHOULD

code
v: MAY

code
v: MAY

code
v: MAY

code
v: SHOULD

code
v: MAY

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
code:
  v: history-instance

v: resolves

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
type:
  v: Consent
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-HealthcareAgentConsent|2.0.0-ballot
  link: 2.0
  link: .0
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: search-type
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: vread
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: history-instance
reference policy:
  v: resolves

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
type:
  v: DocumentReference
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-DocumentReference|2.0.0-ballot
  link: 2.0
  link: .0
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: search-type
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: vread
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: history-instance
reference policy:
  v: resolves
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: authenticator
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-authenticator
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-authenticator
  type:
    v: reference
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: author
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-author
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-author
  type:
    v: reference
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: category
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-category
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-category
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: contenttype
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: custodian
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-custodian
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-custodian
  type:
    v: reference
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: date
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-date
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-date
  type:
    v: date
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: description
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-description
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-description
  type:
    v: string
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: encounter
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-encounter
    link: http://hl7.org/fhir/SearchParameter/clinical-encounter
  type:
    v: reference
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: event
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-event
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-event
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: facility
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-facility
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-facility

v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: format
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-format
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-format
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: identifier
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-identifier
  link: http://hl7.org/fhir/SearchParameter/clinical-identifier
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: language
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-language
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-language
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: location
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-location
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-location
type:
  v: uri

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: patient
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-patient
  link: http://hl7.org/fhir/SearchParameter/clinical-patient
type:
  v: reference

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: period
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-period
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-period
type:
  v: date

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: related
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-related
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-related
type:
  v: reference

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: relatesto
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto
type:
  v: reference

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: relation
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-relation
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-relation
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: security-label
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-security-label
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-security-label
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: setting
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-setting
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-setting
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: status
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-status
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-status
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: subject
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-subject
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-subject
type:
  v: reference

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: type
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-type
  link: http://hl7.org/fhir/SearchParameter/clinical-type
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
type:
  v: Goal
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-PersonalGoal|2.0.0-ballot
  link: 2.0
  link: .0
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: search-type
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: vread
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: history-instance
reference policy:
  v: resolves

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
type:
  v: List
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-PersonalPrioritiesOrganizer|2.0.0-ballot
  link: 2.0
  link: .0
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: search-type
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: vread
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: history-instance
reference policy:
  v: resolves

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
type:
  v: Observation
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-DocumentationObservation|2.0.0-ballot
  link: 2.0
  link: .0
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-PersonalInterventionPreference|2.0.0-ballot
  link: 2.0
  link: .0
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-OrganDonationObservation|2.0.0-ballot
  link: 2.0
  link: .0
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-AutopsyObservation|2.0.0-ballot
  link: 2.0
  link: .0
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-CareExperiencePreference|2.0.0-ballot
  link: 2.0
  link: .0
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: search-type
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: vread
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: history-instance
reference policy:
  v: resolves

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
type:
  v: Organization
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: search-type
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: vread
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: history-instance
reference policy:
  v: resolves

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
type:
  v: Patient
supported profile:
  v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
  link: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: search-type
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: vread
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: history-instance
reference policy:
  v: resolves
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id
    link: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id
  type:
    v: token
  documentation:
    v: https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-id.html
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: active
  definition:
    v: http://hl7.org/fhir/SearchParameter/Patient-active
    link: http://hl7.org/fhir/SearchParameter/Patient-active
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: address
  definition:
    v: http://hl7.org/fhir/SearchParameter/individual-address
    link: http://hl7.org/fhir/SearchParameter/individual-address
  type:
    v: string
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: address-city
  definition:
    v: http://hl7.org/fhir/SearchParameter/individual-address-city
    link: http://hl7.org/fhir/SearchParameter/individual-address-city
  type:
    v: string
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: address-country
  definition:
    v: http://hl7.org/fhir/SearchParameter/individual-address-country
    link: http://hl7.org/fhir/SearchParameter/individual-address-country
  type:
    v: string
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: address-postalcode
  definition:
    v: http://hl7.org/fhir/SearchParameter/individual-address-postalcode
    link: http://hl7.org/fhir/SearchParameter/individual-address-postalcode
  type:
    v: string
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: address-state
  definition:
    v: http://hl7.org/fhir/SearchParameter/individual-address-state
    link: http://hl7.org/fhir/SearchParameter/individual-address-state
  type:
    v: string
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: address-use
  definition:
    v: http://hl7.org/fhir/SearchParameter/individual-address-use
    link: http://hl7.org/fhir/SearchParameter/individual-address-use
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
  name:
    v: birthdate
  definition:
    v: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate
    link: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate
  type:
    v: date
  documentation:
    v: https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-birthdate.html
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: death-date
  definition:
    v: http://hl7.org/fhir/SearchParameter/Patient-death-date
    link: http://hl7.org/fhir/SearchParameter/Patient-death-date
  type:
    v: date
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  name:
    v: deceased

v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: email
definition:
  v: http://hl7.org/fhir/SearchParameter/individual-email
  link: http://hl7.org/fhir/SearchParameter/individual-email
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: family
definition:
  v: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family
  link: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family
type:
  v: string
documentation:
  v: https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-family.html

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: general-practitioner
definition:
  v: http://hl7.org/fhir/SearchParameter/Patient-general-practitioner
  link: http://hl7.org/fhir/SearchParameter/Patient-general-practitioner
type:
  v: reference

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: given
definition:
  v: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given
  link: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given
type:
  v: string
documentation:
  v: https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: identifier
definition:
  v: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier
  link: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier
type:
  v: token
documentation:
  v: https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-identifier.html

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: language
definition:
  v: http://hl7.org/fhir/SearchParameter/Patient-language
  link: http://hl7.org/fhir/SearchParameter/Patient-language
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: link
definition:
  v: http://hl7.org/fhir/SearchParameter/Patient-link
  link: http://hl7.org/fhir/SearchParameter/Patient-link
type:
  v: reference

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHALL
name:
  v: name
definition:
  v: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name
  link: http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name
type:
  v: string
documentation:
  v: https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-name.html

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: organization
definition:
  v: http://hl7.org/fhir/SearchParameter/Patient-organization
  link: http://hl7.org/fhir/SearchParameter/Patient-organization
type:
  v: reference

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: phone
definition:
  v: http://hl7.org/fhir/SearchParameter/individual-phone
  link: http://hl7.org/fhir/SearchParameter/individual-phone
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: phonetic
definition:
  v: http://hl7.org/fhir/SearchParameter/individual-phonetic
  link: http://hl7.org/fhir/SearchParameter/individual-phonetic
type:
  v: string

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: telecom
definition:
  v: http://hl7.org/fhir/SearchParameter/individual-telecom
  link: http://hl7.org/fhir/SearchParameter/individual-telecom
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: race
definition:
  v: http://hl7.org/fhir/us/core/SearchParameter/us-core-race
  link: http://hl7.org/fhir/us/core/SearchParameter/us-core-race
type:
  v: token
documentation:
  v: https://www.hl7.org/fhir/us/core/SearchParameter-us-core-race.html

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
name:
  v: ethnicity
definition:
  v: http://hl7.org/fhir/us/core/SearchParameter/us-core-ethnicity
  link: http://hl7.org/fhir/us/core/SearchParameter/us-core-ethnicity
type:
  v: token
documentation:
  v: https://www.hl7.org/fhir/us/core/SearchParameter-us-core-ethnicity.html

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
type:
  v: Provenance
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Provenance|2.0.0-ballot
  link: 2.0
  link: .0
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: search-type
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: vread
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: history-instance
reference policy:
  v: resolves

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: MAY
type:
  v: RelatedPerson
supported profile:
  v: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-HealthcareAgentParticipant|2.0.0-ballot
  link: 2.0
  link: .0
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: search-type
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: vread
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: MAY
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  code:
    v: history-instance
reference policy:
  v: resolves

type:
  v: OperationDefinition
operation:
  name:
    v: $match
  definition:
    v: http://hl7.org/fhir/OperationDefinition/Patient-match
    link: http://hl7.org/fhir/OperationDefinition/Patient-match
  documentation:
    v: $match is a service used to manage patient identification in a context where multiple patient databases exist.To ask an MPI to match a patient, clients use the '$match' operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set.