GPConnect-RegisterPatient-Operation-1

HTML View

Invocations

URL: [base]/Patient/$gpc.registerpatient

Parameters (In)

NameCardinalityTypeStructureDefinitionDocumentation
registerPatient1..1PatientCareConnect-GPC-Patient-1

Patient demographic information captured in the patient resource to register the patient.

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
response1..1BundleGPConnect-Searchset-Bundle-1

The searchset bundle resource that has been returned in response to the given input parameters

Table View

OperationDefinition.id[0]GPConnect-RegisterPatient-Operation-1
OperationDefinition.meta[0].lastUpdated[0]2017-11-21T00:00:00+01:00
OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-RegisterPatient-Operation-1
OperationDefinition.version[0]1.0.0
OperationDefinition.name[0]GPConnect-RegisterPatient-Operation
OperationDefinition.status[0]active
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2017-11-21
OperationDefinition.publisher[0]NHS Digital
OperationDefinition.contact[0].name[0]Interoperability Team
OperationDefinition.contact[0].telecom[0].system[0]email
OperationDefinition.contact[0].telecom[0].value[0]interoperabilityteam@nhs.net
OperationDefinition.contact[0].telecom[0].use[0]work
OperationDefinition.description[0]Request to register a patient at a healthcare organisation
OperationDefinition.code[0]gpc.registerpatient
OperationDefinition.resource[0]Patient
OperationDefinition.system[0]False
OperationDefinition.type[0]True
OperationDefinition.instance[0]False
OperationDefinition.parameter[0].name[0]registerPatient
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]1
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]Patient demographic information captured in the patient resource to register the patient.
OperationDefinition.parameter[0].type[0]Patient
OperationDefinition.parameter[0].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1
OperationDefinition.parameter[1].name[0]response
OperationDefinition.parameter[1].use[0]out
OperationDefinition.parameter[1].min[0]1
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]The searchset bundle resource that has been returned in response to the given input parameters
OperationDefinition.parameter[1].type[0]Bundle
OperationDefinition.parameter[1].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Searchset-Bundle-1

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="GPConnect-RegisterPatient-Operation-1" />
<meta>
<lastUpdated value="2017-11-21T00:00:00+01:00" />
</meta>
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-RegisterPatient-Operation-1" />
<version value="1.0.0" />
<name value="GPConnect-RegisterPatient-Operation" />
<status value="active" />
<kind value="operation" />
<date value="2017-11-21" />
<publisher value="NHS Digital" />
<contact>
<name value="Interoperability Team" />
<telecom>
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
</telecom>
</contact>
<description value="Request to register a patient at a healthcare organisation" />
<code value="gpc.registerpatient" />
<resource value="Patient" />
<system value="false" />
<type value="true" />
<instance value="false" />
<parameter>
<name value="registerPatient" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Patient demographic information captured in the patient resource to register the patient." />
<type value="Patient" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" />
</profile>
</parameter>
<parameter>
<name value="response" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The searchset bundle resource that has been returned in response to the given input parameters" />
<type value="Bundle" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Searchset-Bundle-1" />
</profile>
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"id": "GPConnect-RegisterPatient-Operation-1",
"meta": {
"lastUpdated": "2017-11-21T00:00:00+01:00"
},
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-RegisterPatient-Operation-1",
"version": "1.0.0",
"name": "GPConnect-RegisterPatient-Operation",
"status": "active",
"kind": "operation",
"date": "2017-11-21",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "Request to register a patient at a healthcare organisation",
"code": "gpc.registerpatient",
"resource": [
"Patient"
],
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "registerPatient",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Patient demographic information captured in the patient resource to register the patient.",
"type": "Patient",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1"
}
},
{
"name": "response",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The searchset bundle resource that has been returned in response to the given input parameters",
"type": "Bundle",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Searchset-Bundle-1"
}
}
]
}
---
back to top