{
  "description": null,
  "_filename": "ig-r4.json",
  "package_name": "hl7.fhir.uv.ipa",
  "definition": {
    "page": {
      "page": [ {
        "title": "International Patient Access",
        "nameUrl": "index.html",
        "generation": "markdown"
      }, {
        "title": "Gaining Access to a patient record",
        "nameUrl": "access.html",
        "generation": "markdown"
      }, {
        "title": "Finding / Retrieving information about the patient",
        "nameUrl": "fetching.html",
        "generation": "markdown"
      }, {
        "title": "Generating Patient Documents",
        "nameUrl": "doc-gen.html",
        "generation": "markdown"
      }, {
        "title": "Internationalization Issues",
        "nameUrl": "internationalization.html",
        "generation": "markdown"
      }, {
        "title": "Safety Check List",
        "nameUrl": "safety.html",
        "generation": "markdown"
      }, {
        "title": "Security",
        "nameUrl": "security.html",
        "generation": "markdown"
      }, {
        "title": "Privacy and Consent",
        "nameUrl": "privacy.html",
        "generation": "markdown"
      }, {
        "title": "Synchronizing Patient Records",
        "nameUrl": "synchronization.html",
        "generation": "markdown"
      }, {
        "title": "Conforming to this specification",
        "nameUrl": "conformance.html",
        "generation": "markdown"
      }, {
        "title": "IPA Specifications by Country",
        "nameUrl": "ipa-by-country.html",
        "generation": "markdown"
      }, {
        "title": "Relationship with International Patient Summary",
        "nameUrl": "ips-relationship.html",
        "generation": "markdown"
      }, {
        "title": "Artifact List",
        "nameUrl": "artifacts.html",
        "generation": "markdown"
      }, {
        "title": "Downloads",
        "nameUrl": "downloads.html",
        "generation": "markdown"
      }, {
        "title": "IPA Server Requirements",
        "nameUrl": "ipa-server.html",
        "generation": "markdown"
      } ],
      "title": "Table of Contents",
      "nameUrl": "toc.html",
      "generation": "html"
    },
    "resource": [ {
      "name": "International Patient Access Server CapabilityStatement",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CapabilityStatement"
      } ],
      "reference": {
        "reference": "CapabilityStatement/ipa-server"
      },
      "description": "This section describes the basic rules for the International Patient Access server actor that is responsible for providing responses to queries submitted by International Patient Access requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by International Patient Access servers are defined in this CapabilityStatement. International Patient Access clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements."
    }, {
      "name": "IPA Fetch DocumentReference",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "OperationDefinition"
      } ],
      "reference": {
        "reference": "OperationDefinition/docref"
      },
      "description": "This operation is used to return all the references to documents related to a patient. \n\n The operation requires a patient id and takes the optional input parameters: \n  - start date\n  - end date\n  - document type \n\n and returns a [Bundle](http://hl7.org/fhir/bundle.html) of type \"searchset\" containing [DocumentReference](StructureDefinition-ipa-documentreference.html) resources for the patient. If the server has or can create documents that are related to the patient, and that are available for the given user, the server returns the DocumentReference resources needed to support the records.  The principle intended use for this operation is to provide a patient with access to their available document information. \n\n This operation is *different* from a search by patient and type and date range because: \n\n 1. It is used to request a server *generate* a document based on the specified parameters. \n\n 1. If no parameters are specified, the server SHALL return a DocumentReference to the patient's most current summary document (depending on jurisdiction) \n\n 1. If the server cannot *generate* a document based on the specified parameters, the operation will return an empty search bundle. \n\n This operation is the *same* as a FHIR RESTful search by patient, type and date range because: \n\n 1. References for *existing* documents that meet the requirements of the request SHOULD also be returned unless the client indicates they are only interested in 'on-demand' documents using the *on-demand* parameter."
    }, {
      "name": "IPA-AllergyIntolerance",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-allergyintolerance"
      },
      "description": "Minimum expectations for an AllergyIntolerance resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA AllergyIntolerance example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "AllergyIntolerance"
      } ],
      "reference": {
        "reference": "AllergyIntolerance/AllIntExample1"
      },
      "description": "AllergyIntolerance example",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance"
    }, {
      "name": "IPA-Condition",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-condition"
      },
      "description": "Minimum expectations for a Condition resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA Condition example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Condition"
      } ],
      "reference": {
        "reference": "Condition/ProblemExample1"
      },
      "description": "Condition example for problem list item",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition"
    }, {
      "name": "IPA-DocumentReference",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-documentreference"
      },
      "description": "Minimum expectations for a DocumentReference resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA DocumentReference example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "DocumentReference"
      } ],
      "reference": {
        "reference": "DocumentReference/USClinicalNoteExample1"
      },
      "description": "DocumentReference example",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference"
    }, {
      "name": "IPA-Immunization",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-immunization"
      },
      "description": "Minimum expectations for an Immunization resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA Immunization example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Immunization"
      } ],
      "reference": {
        "reference": "Immunization/ImmExample1"
      },
      "description": "Immunization example",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization"
    }, {
      "name": "IPA-Medication",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-medication"
      },
      "description": "Minimum expectations for a Medication resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA Medication example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Medication"
      } ],
      "reference": {
        "reference": "Medication/MedExample1"
      },
      "description": "Medication example",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication"
    }, {
      "name": "IPA-MedicationRequest",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-medicationrequest"
      },
      "description": "Minimum expectations for a MedicationRequest resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA MedicationRequest example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "MedicationRequest"
      } ],
      "reference": {
        "reference": "MedicationRequest/MedRecExample1"
      },
      "description": "MedicationRequest example",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest"
    }, {
      "name": "IPA-MedicationStatement",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-medicationstatement"
      },
      "description": "Minimum expectations for a MedicationStatement resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA Medication Statement example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "MedicationStatement"
      } ],
      "reference": {
        "reference": "MedicationStatement/MedStatementExample1"
      },
      "description": "Medication Statement example",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement"
    }, {
      "name": "IPA-Observation",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-observation"
      },
      "description": "Minimum expectations for an Observation resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA Lab Observation example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Observation"
      } ],
      "reference": {
        "reference": "Observation/LabExample1"
      },
      "description": "Laboratory Observation example",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation"
    }, {
      "name": "IPA Smoking Observation example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Observation"
      } ],
      "reference": {
        "reference": "Observation/SmokingExample1"
      },
      "description": "Social History Smoking Observation example",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation"
    }, {
      "name": "IPA Vital Signs Observation example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Observation"
      } ],
      "reference": {
        "reference": "Observation/VitalSignsExample1"
      },
      "description": "FHIR Core Vital Signs Profile example",
      "exampleCanonical": "http://hl7.org/fhir/StructureDefinition/vitalsigns"
    }, {
      "name": "IPA-Patient",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-patient"
      },
      "description": "Minimum expectations for a Patient resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA Patient example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Patient"
      } ],
      "reference": {
        "reference": "Patient/PatientExample1"
      },
      "description": "Meiko Lufhir Jr., PhD",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient"
    }, {
      "name": "IPA-Practitioner",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-practitioner"
      },
      "description": "Minimum expectations for a Practitioner resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA Practitioner example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Practitioner"
      } ],
      "reference": {
        "reference": "Practitioner/PractitionerExample1"
      },
      "description": "Marty Seeger",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner"
    }, {
      "name": "IPA-PractitionerRole",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/ipa-practitionerrole"
      },
      "description": "Minimum expectations for a PractitionerRole resource when accessed via a International Patient Access API"
    }, {
      "name": "IPA Practitioner Role example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "PractitionerRole"
      } ],
      "reference": {
        "reference": "PractitionerRole/PractitionerRoleExample1"
      },
      "description": "The first example for IPA",
      "exampleCanonical": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole"
    } ],
    "parameter": [ {
      "code": "logging",
      "value": "init"
    }, {
      "code": "logging",
      "value": "progress"
    }, {
      "code": "logging",
      "value": "tx"
    }, {
      "code": "logging",
      "value": "context"
    }, {
      "code": "releaselabel",
      "value": "STU 1 ballot"
    }, {
      "code": "copyrightyear",
      "value": "2021+"
    }, {
      "code": "show-inherited-invariants",
      "value": "false"
    }, {
      "code": "path-resource",
      "value": "input/capabilities"
    }, {
      "code": "path-resource",
      "value": "input/examples"
    }, {
      "code": "path-resource",
      "value": "input/extensions"
    }, {
      "code": "path-resource",
      "value": "input/models"
    }, {
      "code": "path-resource",
      "value": "input/operations"
    }, {
      "code": "path-resource",
      "value": "input/profiles"
    }, {
      "code": "path-resource",
      "value": "input/resources"
    }, {
      "code": "path-resource",
      "value": "input/vocabulary"
    }, {
      "code": "path-resource",
      "value": "input/maps"
    }, {
      "code": "path-resource",
      "value": "input/testing"
    }, {
      "code": "path-resource",
      "value": "input/history"
    }, {
      "code": "path-resource",
      "value": "fsh-generated/resources"
    }, {
      "code": "path-pages",
      "value": "template/config"
    }, {
      "code": "path-pages",
      "value": "input/images"
    }, {
      "code": "path-liquid",
      "value": "template/liquid"
    }, {
      "code": "path-liquid",
      "value": "input/liquid"
    }, {
      "code": "path-qa",
      "value": "temp/qa"
    }, {
      "code": "path-temp",
      "value": "temp/pages"
    }, {
      "code": "path-output",
      "value": "output"
    }, {
      "code": "path-tx-cache",
      "value": "input-cache/txcache"
    }, {
      "code": "path-suppressed-warnings",
      "value": "input/ignoreWarnings.txt"
    }, {
      "code": "path-history",
      "value": "http://hl7.org/fhir/uv/ipa/history.html"
    }, {
      "code": "template-html",
      "value": "template-page.html"
    }, {
      "code": "template-md",
      "value": "template-page-md.html"
    }, {
      "code": "apply-contact",
      "value": "true"
    }, {
      "code": "apply-context",
      "value": "true"
    }, {
      "code": "apply-copyright",
      "value": "true"
    }, {
      "code": "apply-jurisdiction",
      "value": "true"
    }, {
      "code": "apply-license",
      "value": "true"
    }, {
      "code": "apply-publisher",
      "value": "true"
    }, {
      "code": "apply-version",
      "value": "true"
    }, {
      "code": "active-tables",
      "value": "true"
    } ]
  },
  "date": "2021-12-06T16:10:37+00:00",
  "publisher": "HL7 International - Patient Care Workgroup",
  "fhirVersion": [ "4.0.1" ],
  "license": "CC0-1.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
    } ]
  } ],
  "dependsOn": [ {
    "uri": "http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch",
    "version": "2.0.0",
    "packageId": "hl7.fhir.uv.smart-app-launch"
  } ],
  "name": "InternationalPatientAccess",
  "copyright": "Creative Commons Public Domain",
  "type": null,
  "experimental": null,
  "resourceType": "ImplementationGuide",
  "title": "International Patient Access",
  "package_version": "0.1.0",
  "status": "draft",
  "id": "b61728d3-9bef-40e3-b8b6-e8d81e7c0f01",
  "kind": null,
  "url": "http://hl7.org/fhir/uv/ipa/ImplementationGuide/hl7.fhir.uv.ipa",
  "version": "0.1.0",
  "packageId": "hl7.fhir.uv.ipa",
  "contact": [ {
    "telecom": [ {
      "value": "https://www.hl7.org/Special/committees/patientcare",
      "system": "url"
    } ]
  } ]
}