API Hub

Explore and Make use of Nationally Defined Messaging APIs

Version ID Description Card. Type Context
STU3 Draft Extension-CareConnect-GPC-AllergyCertainty-1 Certainty that the stated causative agent caused the allergic or adverse reaction 0..* CodeableConcept
AllergyIntolerance.reaction
STU3 Active Extension-CareConnect-GPC-AllergyIntoleranceEnd-1 Supports the date and reason that the allergy was no longer valid 0..* (complex)
AllergyIntolerance
STU3 Draft Extension-CareConnect-GPC-AllergyIntoleranceEndDate-1 Allergy end date 0..* dateTime
AllergyIntolerance
STU3 Draft Extension-CareConnect-GPC-AllergySeverity-1 0..* (complex)
AllergyIntolerance.reaction
STU3 Active Extension-CareConnect-GPC-ClinicalSetting-1 To record the clinical setting of a problem list 0..1 CodeableConcept
List
STU3 Draft Extension-CareConnect-GPC-ConditionEpisode-1 Episodicity of condition 0..* code
Condition
STU3 Draft Extension-CareConnect-GPC-ConditionRelationship-1 Related condition 0..* (complex)
Condition
STU3 Draft Extension-CareConnect-GPC-DateRecorded-1 The date that the event was recorded 0..* dateTime
Immunization
Procedure
STU3 Active Extension-CareConnect-GPC-DeathNotificationStatus-1 Representation of a patient’s death notification (as held on Personal Demographics Service (PDS)) 0..1 CodeableConcept
Patient
STU3 Active Extension-CareConnect-GPC-EthnicCategory-1 Ethnic category 0..* CodeableConcept
Patient
STU3 Active Extension-CareConnect-GPC-Evidence-1 A reference to results of investigations that confirmed the certainty of the diagnosis 0..* Reference
AllergyIntolerance
STU3 Draft Extension-CareConnect-GPC-ListWarningCode-1 To capture warnings that the list may be incomplete 0..* code
List
STU3 Active Extension-CareConnect-GPC-MainLocation-1 Main location 0..* Reference
Organization
STU3 Active Extension-CareConnect-GPC-MedicationChangeSummary-1 Indicates the change information of a medication item 0..1 (complex)
MedicationStatement
STU3 Draft Extension-CareConnect-GPC-MedicationOrderStatement-1 Medication Statement link 0..* Reference
MedicationRequest
STU3 Active Extension-CareConnect-GPC-MedicationQuantityText-1 Quantity representation 0..* string
MedicationRequest.dispenseRequest.quantity
STU3 Active Extension-CareConnect-GPC-MedicationRepeatInformation-1 Medication repeat information 0..1 (complex)
MedicationRequest
STU3 Active Extension-CareConnect-GPC-MedicationStatementLastIssueDate-1 The date a prescription was last issued 0..* dateTime
MedicationStatement
STU3 Draft Extension-CareConnect-GPC-MedicationStatementQuantity-1 Amount of medication to supply per dispense 0..* (complex)
MedicationStatement
STU3 Active Extension-CareConnect-GPC-MedicationStatusReason-1 To record the reason the medication (plan or order) was stopped and the date this occurred 0..1 (complex)
MedicationRequest
STU3 Active Extension-CareConnect-GPC-MedicationSupplyType-1 Medication supply type 0..* CodeableConcept
MedicationRequest
STU3 Active Extension-CareConnect-GPC-NHSCommunication-1 NHS communication preferences for a resource 0..* (complex)
Patient
Practitioner
STU3 Active Extension-CareConnect-GPC-NHSNumberVerificationStatus-1 NHS number verification status 0..* CodeableConcept
Patient.identifier
STU3 Active Extension-CareConnect-GPC-NominatedPharmacy-1 A patient's nominated pharmacy 0..1 Reference
Patient
STU3 Draft Extension-CareConnect-GPC-ParentPresent-1 Was a parent present at the Immunization 0..* boolean
Immunization
STU3 Active Extension-CareConnect-GPC-PrescribingAgency-1 The type of organisation/setting responsible for authorising and issuing a medication outside of a GP system 0..1 CodeableConcept
MedicationStatement
STU3 Active Extension-CareConnect-GPC-PrescriptionType-1 To record the type of prescription 0..1 CodeableConcept
MedicationRequest
STU3 Draft Extension-CareConnect-GPC-ProbabilityOfRecurrence-1 The probability of the reaction (allergic, adverse, intolerant) occurring 0..* string
AllergyIntolerance
STU3 Draft Extension-CareConnect-GPC-ReasonCondition-1 Reason resource added/performed/given 0..* (choice)
Observation
Procedure
MedicationStatement
MedicationRequest
STU3 Active Extension-CareConnect-GPC-RegistrationDetails-1 Additional registration information for the Patient resource 0..* (complex)
Patient
STU3 Active Extension-CareConnect-GPC-ReligiousAffiliation-1 Religious affiliation 0..* CodeableConcept
Patient
STU3 Active Extension-CareConnect-GPC-ResidentialStatus-1 The residential status of the patient 0..1 CodeableConcept
Patient
STU3 Active Extension-CareConnect-GPC-TreatmentCategory-1 The treatment category for this patient 0..1 CodeableConcept
Patient
STU3 Draft Extension-CareSettingType-1 An extension to carry the Care setting type of the document 0..* (complex)
Composition
MessageHeader
DocumentReference
MessageHeader.event
STU3 Active Extension-GPConnect-AppointmentCancellationReason-1 The reason the appointment was cancelled 0..1 string
Appointment
STU3 Active Extension-GPConnect-BookingOrganisation-1 An extension to record the organisation booking the appointment 0..1 Reference
Appointment
STU3 Draft Extension-GPConnect-CareSettingType-1 The care setting type for a Composition 0..1 (complex)
Composition
STU3 Active Extension-GPConnect-DeliveryChannel-1 An extension to record the delivery channel of a scheduled Appointment 0..1 CodeableConcept
Slot
Appointment
STU3 Active Extension-GPConnect-DeliveryChannel-2 An extension to record the delivery channel of a scheduled Appointment 0..1 code
Slot
Appointment
STU3 Active Extension-GPConnect-PractitionerRole-1 An extension to record the role of the Practitioner of a scheduled Appointment 0..* CodeableConcept
Schedule
Appointment
STU3 Draft Extension-ITK-BundledAssets-1 1..* (complex)
MessageDefinition.focus.profile
STU3 Draft Extension-ImageCoordinates-1 An Extension to record a reference to an image and co-ordinates including X, Y and Z co-ordinates of a location within an image. 1..1 (complex)
Basic
STU3 Draft Extension-NRL-ContentStability-1 Record content stabilty 1..1 (complex)
DocumentReference.content
STU3 Active Extension-RARecord-AdjustmentCategory-1 0..* (complex)
Flag
STU3 Active Extension-RARecord-AdjustmentNotes-1 0..* (complex)
Flag
STU3 Active Extension-RARecord-BestInterestSummary-1 0..* (complex)
Consent
STU3 Active Extension-RARecord-Provenance-1 0..1 (complex)
Flag
Condition
Consent
STU3 Active Extension-RARecord-ProxyRole-1 0..* (complex)
Consent
STU3 Active Extension-RARecord-RemovalReason-1 0..* (complex)
Consent
Flag
Condition
STU3 Draft Extension-UEC-FlagBasedOn-1 An Extension to identify what a Flag is based on. This allows a history of the provenance to be carried. 0..* Reference
Flag
STU3 Active Extension-coding-sctdescid The SNOMED CT Description ID for the display 0..1 (complex)
Encounter
Condition
Observation
Flag
Immunization
AllergyIntolerance
FamilyMemberHistory
MedicationRequest
MedicationStatement
Procedure
Medication
DocumentReference
STU3 Active Extension-eRS-Appointment-1 0..* (complex)
ReferralRequest
STU3 Active Extension-eRS-ClinicalInfoFirstSubmitted-1 0..* (complex)
ReferralRequest
STU3 Active Extension-eRS-ClinicalInfoLastUpdated-1 0..* (complex)
ReferralRequest
STU3 Draft Extension-eRS-ReferralPriority-1 1..1 (complex)
ReferralRequest