API Hub

Explore and Make use of Nationally Defined Messaging APIs

Version ID Description Card. Type Context
DSTU2 Active Extension-CareConnect-GPC-EthnicCategory-1 Ethnic category 0..* CodeableConcept
Patient
DSTU2 Active Extension-CareConnect-GPC-MainLocation-1 Main location 0..* Reference
Organization
DSTU2 Active Extension-CareConnect-GPC-NHSCommunication-1 NHS communication preferences for a resource 0..* (complex)
Patient
Practitioner
DSTU2 Active Extension-CareConnect-GPC-NHSNumberVerificationStatus-1 NHS number verification status 0..* CodeableConcept
Patient.identifier
DSTU2 Active Extension-CareConnect-GPC-RegistrationDetails-1 Additional registration information for the Patient resource 0..1 (complex)
Patient
DSTU2 Active Extension-CareConnect-GPC-ReligiousAffiliation-1 Religious affiliation 0..* CodeableConcept
Patient
DSTU2 Active Extension-CareConnect-GPC-ResidentialStatus-1 The residential status of the patient 0..1 CodeableConcept
Patient.identifier
DSTU2 Active Extension-CareConnect-GPC-TreatmentCategory-1 The treatment category for this patient 0..1 CodeableConcept
Patient.identifier
DSTU2 Active Extension-GPC-CareSettingType-1 The care setting type for a Composition. 0..* CodeableConcept
Composition
DSTU2 Draft Extension-GPConnect-Appointment-Cancellation-Reason-1 The reason the appointment was cancelled. 0..* string
Appointment
DSTU2 Active Extension-GPConnect-Appointment-Created-1 An extension to support the date that the appointment was initially created. 0..1 dateTime
Appointment
DSTU2 Active Extension-GPConnect-Booking-Organisation-1 An extension to record the organisation booking the appointment. 0..1 Reference
Appointment
DSTU2 Draft Extension-GPConnect-Practitioner-1 A practitioner reference for a Schedule Resource. 0..* Reference
Schedule
DSTU2 Active organization-period The date range that this organization should be considered available. 0..* Period
Organization
DSTU2 Active patient-birthTime The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. 0..1 dateTime
Patient
DSTU2 Draft patient-cadavericDonor Flag indicating whether the patient authorized the donation of body parts after death. 0..* boolean
Patient
STU3 Draft Extension-CapabilityStatement-Expectation-1 SHALL | SHOULD | MAY |SHOULD-NOT 0..1 code
CapabilityStatement.rest.resource.interaction
CapabilityStatement.rest.resource.searchParam
CapabilityStatement.rest.operation
CapabilityStatement.messaging.event
CapabilityStatement.document
CapabilityStatement.rest.interaction
CapabilityStatement.rest.resource.searchInclude
CapabilityStatement.rest.resource.searchRevInclude
STU3 Draft Extension-CareConnect-AdmissionMethod-1 An extension to the Encounter resource to record how a Patient was admitted to hospital. 0..1 CodeableConcept
Encounter.hospitalization
STU3 Draft Extension-CareConnect-AllergyIntoleranceEnd-1 Supports the date and reason that the allergy was no longer valid 0..* (complex)
AllergyIntolerance
STU3 Draft Extension-CareConnect-ConditionEpisode-1 Episodicity of condition 0..* code
Condition
STU3 Draft Extension-CareConnect-ConditionRelationship-1 Related condition 0..* (complex)
Condition
STU3 Draft Extension-CareConnect-DCH-EmergencyCareDischargeStatus-1 An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. 0..1 (complex)
Encounter
STU3 Draft Extension-CareConnect-DCH-FetalDiagnosis-ConditionRelationship-1 Related condition 0..* (complex)
Condition
STU3 Draft Extension-CareConnect-DateRecorded-1 The date that the event was recorded 0..* dateTime
Immunization
Procedure
STU3 Draft Extension-CareConnect-DischargeMethod-1 An extension to the Encounter resource to record the method of discharge from hospital. 0..1 CodeableConcept
Encounter.hospitalization
STU3 Draft Extension-CareConnect-EmergencyCareDischargeStatus-1 An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department. 0..1 CodeableConcept
Encounter
STU3 Draft Extension-CareConnect-EncounterTransport-1 Encounter transport 0..1 (complex)
Encounter
STU3 Draft Extension-CareConnect-Evidence-1 A reference to results of investigations that confirmed the certainty of the diagnosis 0..* Reference
AllergyIntolerance
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 Active Extension-CareConnect-GPC-ListWarningCode-1 To capture warnings that the list may be incomplete 0..1 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 Draft Extension-CareConnect-GPC-MedicationStatementReasonEnded-1 Why prescription was stopped 0..* CodeableConcept
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 Draft 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-CareConnect-ITK-MedicationFlagAssociation-1 Associated medication 1..* (complex)
Flag
STU3 Draft Extension-CareConnect-MainLocation-1 Main location 0..* Reference
Organization
STU3 Draft Extension-CareConnect-MedicationChangeSummary-1 Indicates the change information of a medication item 0..1 (complex)
MedicationStatement
STU3 Draft Extension-CareConnect-MedicationFlag-1 Flags related to the patient's medications 0..* Reference
MedicationRequest
MedicationStatement
STU3 Draft Extension-CareConnect-MedicationRepeatInformation-1 Medication repeat information 0..* (complex)
MedicationStatement
STU3 Draft Extension-CareConnect-MedicationStatementLastIssueDate-1 The date a prescription was last issued 0..* dateTime
MedicationStatement
STU3 Draft Extension-CareConnect-MedicationStatementQuantity-1 Amount of medication to supply per dispense 0..* (complex)
MedicationStatement
STU3 Draft Extension-CareConnect-MedicationStatementReasonEnded-1 Why prescription was stopped 0..* CodeableConcept
MedicationStatement
STU3 Draft Extension-CareConnect-NHSCommunication-1 NHS communication preferences for a resource 0..* (complex)
Patient
Practitioner
STU3 Draft Extension-CareConnect-OutcomeOfAttendance-1 An extension to the Encounter resource to record the outcome of an Out-Patient attendance. 0..1 CodeableConcept
Encounter
STU3 Draft Extension-CareConnect-ReasonCondition-1 Reason resource added/performed/given 0..* (choice)
Observation
Procedure
MedicationStatement
MedicationRequest
STU3 Draft Extension-CareSettingType-1 An extension to carry the Care setting type of the document 0..* (complex)
Composition
MessageHeader
DocumentReference
MessageHeader.event
STU3 Draft Extension-DCH-HouseholdMember-1 The household member information for a person related to the Patient 0..* (complex)
RelatedPerson
STU3 Draft Extension-DCH-Link-1 Link to a Patient resource for a Related Person 0..* Reference
RelatedPerson
STU3 Draft Extension-DCH-MessageEventType-1 The type of event applicable to the Child Health event message 0..* (complex)
MessageHeader
STU3 Draft Extension-DCH-ProfessionalContactReason-1 Reason why the Professional Contact association has been created or ended 0..* string
EpisodeOfCare
STU3 Draft Extension-DCH-ReferralRequestMethod-1 The method used to send or receive a Referral Request 0..* (complex)
ReferralRequest
STU3 Draft Extension-DCH-SignificantIndividual-1 Whether an individual related to the child is deemed as key by family 0..* boolean
RelatedPerson
STU3 Draft Extension-DCH-SourceOfReferral-1 Source of referral 0..* (complex)
ReferralRequest
STU3 Draft Extension-EMS-FailsafeAlertEscalationLevel-1 The escalation level applicable to a Failsafe Alert 0..* (complex)
Task
STU3 Draft Extension-EMS-FailsafeAlertSeverityLevel-1 The severity level for the Failsafe Alert 0..* (complex)
Task
STU3 Draft Extension-EMS-MessageEventType-1 The type of event applicable to the event message 0..* (complex)
MessageHeader
STU3 Draft Extension-EMS-PDS-DeathCause-1 Information on the cause of death of the person 0..* (complex)
Communication
STU3 Draft Extension-EMS-PDS-DeathLocationType-1 The type of location at which the person died. 0..* (complex)
Communication
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
Schedule
STU3 Active Extension-GPConnect-PractitionerRole-1 An extension to record the role of the Practitioner of a scheduled Appointment 0..* CodeableConcept
Schedule
STU3 Draft Extension-ITK-AllergyFlagDetail-1 ITK Flag Details 1..* (complex)
Flag
STU3 Draft Extension-ITK-AssociatedEncounter-1 An extension to carry a referenced associated encounter within an ITK message 0..* (complex)
AllergyIntolerance
STU3 Draft Extension-ITK-Authorization-1 Extension for authorization. 0..* (complex)
Composition
DocumentReference
STU3 Draft Extension-ITK-BundledAssets-1 1..* (complex)
MessageDefinition.focus.profile
STU3 Draft Extension-ITK-CareSettingType-1 An extension to carry the Care setting type of the document 0..* (complex)
Composition
MessageHeader
DocumentReference
MessageHeader.event
STU3 Draft Extension-ITK-DataEnterer-1 0..* (complex)
Composition
DocumentReference
STU3 Draft Extension-ITK-Informant-1 Refers to who informed 0..* (complex)
Composition
DocumentReference
STU3 Draft Extension-ITK-InformationRecipient-1 Extension for information recipient. 0..* (complex)
Composition
DocumentReference
STU3 Draft Extension-ITK-MessageHandling-2 An extension to support ITK message handling 0..* (complex)
MessageHeader
STU3 Draft Extension-ITK-Participant-1 Extension for participant. 0..* (complex)
Composition
DocumentReference
STU3 Draft Extension-ITK-Performer-1 0..* (complex)
Composition
DocumentReference
STU3 Draft Extension-ITK-SenderReference-1 An extension to carry a local sender reference value 0..* string
OperationOutcome
MessageHeader
STU3 Draft Extension-NDOP-ActorPerson-1 Actor Person 0..* string
Consent.actor
STU3 Draft Extension-NDOP-NICReference-1 National Information Centre (NIC) Reference 0..1 string
Consent
STU3 Draft Extension-NDOP-OptOutSource-1 Opt-out Source 1..1 (complex)
Consent
STU3 Draft Extension-NDOP-Proxy-1 ConsentingProxyRole 0..1 (complex)
Consent
STU3 Draft Extension-NDOP-ProxyRole-1 ConsentingProxyRole 0..1 (complex)
Consent
STU3 Draft Extension-NHSDigital-ProfileLink-1 Profile link 0..* code
CapabilityStatement.profile
STU3 Active Extension-ODSAPI-ActivePeriod-1 An Extension to represent the organization period and date type. 1..* Period
Organization
STU3 Active Extension-ODSAPI-DateType-1 An extension to define whether the Date Period is 'Legal' or 'Operational'. 1..1 string
Period
STU3 Active Extension-ODSAPI-OrganizationRole-1 An Extension to describe what an Organization does and whether this is the primary role of the Organization. 1..* (complex)
Organization
STU3 Active Extension-ODSAPI-UPRN-1 The Unique Property Reference Number (UPRN) 0..1 string
Organization.address
STU3 Draft Extension-RARecord-AdjustmentCategory-1 0..* (complex)
Flag
STU3 Draft Extension-RARecord-AdjustmentNotes-1 0..* (complex)
Flag
STU3 Draft Extension-RARecord-BestInterestSummary-1 0..* (complex)
Consent
STU3 Draft Extension-RARecord-Provenance-1 0..1 (complex)
Flag
Condition
STU3 Draft Extension-RARecord-ProxyRole-1 0..* (complex)
Consent
STU3 Draft Extension-RARecord-RemovalReason-1 0..* (complex)
Consent
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
STU3 Draft Extension-eRS-Appointment-1 0..* (complex)
ReferralRequest
STU3 Draft Extension-eRS-AttachedBy-1 0..* (complex)
DocumentReference.content.attachment
STU3 Draft Extension-eRS-ClinicalInfoFirstSubmitted-1 0..* (complex)
ReferralRequest
STU3 Draft Extension-eRS-ClinicalInfoLastUpdated-1 0..* (complex)
ReferralRequest
STU3 Draft Extension-eRS-EffectivefromDate-1 0..* (complex)
CodeSystem.concept
STU3 Draft Extension-eRS-EffectivetoDate-1 0..* (complex)
CodeSystem.concept
STU3 Draft Extension-eRS-ReferralPriority-1 1..1 (complex)
ReferralRequest
STU3 Draft Extension-eRS-ReferralsforReview-WorkListItem-1 Referrals for Review 0..* (complex)
List.entry