Operation Defination for provider to gain access to Patient record
"
},
"url": "http://ns.electronichealth.net.au/fhir/v1.3.0/OperationDefinition/patient-access",
"name": "Gain Access to Patient",
"status": "active",
"kind": "operation",
"experimental": "false",
"date": "2017-04-04",
"publisher": "My Health Record System, Australia",
"contact": [
{
"name": "My Health Record Team",
"telecom": [
{
"system": "email",
"value": "MyHealthRecord.Mobile@digitalhealth.gov.au"
}
]
}
],
"description": "The 'access' operation allows the Provider to gain access to the Patient record so that they can view the details associated with the Patient",
"requirements": "The requirement was to enable Provider to gain access to a Patient record by using an API",
"idempotent": "false",
"code": "access",
"comment": "All the search parameters as defined for the My Health Record Patient API apply",
"system": false,
"type": [
"Patient"
],
"instance": true,
"parameter": [
{
"name": "accessType",
"use": "in",
"min": 1,
"max": "1",
"documentation": "This paramater is used to instruct the system about what kind of access is requested on the Patient resource. The values of accessType parameter can be: 'GeneralAccess', 'AccessCode', 'EmergencyAccess'",
"type": "code"
},
{
"name": "subject",
"use": "in",
"min": 0,
"max": "1",
"documentation": "This Patient resource is required if the Provider doesn't have the IHI available to access the record.The Patient resource SHOULD be populated with the folloiwng details: 1) An 'identifier', The value is IHI of the patient. 2) if the 'identifier' is not 'ihi', then provide the following additional details (all of them): 1)'name' should be included with atleast providng the 'family' 2) 'gender' 3)'birthDate'",
"type": "Patient"
},
{
"name": "coverageId",
"use": "in",
"min": "0",
"max": "1",
"documentation": "This search paramater represents the entitlement identifier. the value can be any of : medicareCardNumber/dvaFileNumber/militaryHealthNumber.",
"type": "string",
"searchType": "token"
},
{
"name": "resource-access-status",
"use": "out",
"min": 1,
"max": "1",
"documentation": "This paramater is used to instruct the implementers about status of access request on the Patient resource. The values of resource-access-status parameter can be: 'EmergencyAccess', 'AccessGranted'",
"type": "code"
},
{
"name": "subject",
"use": "out",
"min": 1,
"max": "1",
"documentation": "This Patient resource as available in My Health Record system. The Patient resource will be populated with the folloiwng details: 1) List of 'identifier' elements as applicable, this could be any of : medicareCardNumber/dvaFileNumber/militaryHealthNumber along with IHI. 2) 'name' should be included with atleast providng the 'family' 3) 'gender' 4)'birthDate' 5) 'active' 6) the Logical Id :'id'",
"type": "Patient"
}
]
}