Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
InterweaveAllergyIntolerance |
Interweave AllergyIntolerance resource profile |
InterweaveAppointment |
Interweave Appointment resource profile. |
InterweaveCarePlan |
Interweave CarePlan resource profile. |
InterweaveCondition |
Interweave Condition resource profile. |
InterweaveDiagnosticReport |
Interweave Diagnostic Report resource profile. |
InterweaveDocumentReference |
Interweave DocumentReference resource profile. |
InterweaveEncounter |
Interweave Encounter resource profile. |
InterweaveEncounterGrouping |
Interweave Encounter resource profile to group other encounters into a ‘visit’ |
InterweaveEpisodeOfCare |
Interweave Episode Of Care resource profile |
InterweaveFlag |
Interweave Flag resource profile |
InterweaveHealthcareService |
Interweave HealthcareService resource profile. |
InterweaveLocation |
Interweave Location resource profile. |
InterweaveMedication |
Interweave Medication resource profile. |
InterweaveMedicationAdministration |
Interweave Medication Administration resource profile. |
InterweaveMedicationRequest |
Interweave Medication Request resource profile |
InterweaveObservation |
Interweave Observation resource profile. |
InterweaveObservationACVPU |
Interweave ACVPU Observation resource profile. |
InterweaveObservationAssessmentScore |
Interweave AssessmentScore Observation resource profile. |
InterweaveObservationBloodOxygenSaturation |
Interweave BloodOxygenSaturation Observation resource profile. |
InterweaveObservationBloodPressure |
Interweave BloodPressure Observation resource profile. |
InterweaveObservationBodyTemperature |
Interweave BodyTemperature Observation resource profile. |
InterweaveObservationBreathingAir |
Interweave BreathingAir Observation resource profile. |
InterweaveObservationHeartRate |
Interweave HeartRate Observation resource profile. |
InterweaveObservationHeight |
Interweave Height/length resource profile. |
InterweaveObservationNEWS2Score |
Interweave NEWS2 Score Observation resource profile. |
InterweaveObservationPregnancyEDD |
Interweave Pregnancy Estimated Delivery Date resource profile. |
InterweaveObservationRespiratoryRate |
Interweave RespiratoryRate Observation resource profile. |
InterweaveObservationVitalSigns |
Interweave Vital Signs Observation resource profile. |
InterweaveObservationWeight |
Interweave Weight (Vital signs) resource profile. |
InterweaveOperationOutcome |
Interweave Operation Outcome resource profile. |
InterweaveOrganization |
Interweave Organization resource profile. |
InterweaveOrganizationalTeam |
Interweave Organizational Team resource profile (modelled using FHIR Organization) |
InterweavePatient |
Interweave Patient resource profile. |
InterweavePractitioner |
Interweave Practitioner resource profile. |
InterweavePractitionerRole |
Interweave Practitioner role resource profile. |
InterweaveProcedure |
Interweave Procedure resource profile. |
InterweaveQuestionnaireResponse |
Interweave QuestionnaireResponse resource profile. |
InterweaveReferralRequest |
Interweave Referral Request resource profile. |
InterweaveRelatedPerson |
Interweave Related Person resource profile |
InterweaveSchedule |
Interweave Schedule resource profile. |
InterweaveSlot |
Interweave Slot resource profile. |
InterweaveSocialCareAssessment |
Interweave Social Care Assessment resource profile (modelled using FHIR Task) |
InterweaveSocialCareContact |
Interweave Social Care Contact resource profile (modelled using FHIR ReferralRequest) |
InterweaveSocialCareEquipmentProvision |
Interweave Social Care Equipment Provision resource profile |
InterweaveSocialCareService |
Interweave Social Care Service resource profile (modelled using FHIR EpisodeOfCare) |
InterweaveSocialCareSupportReason |
Interweave Social Care Support Reason resource profile (modelled using FHIR Condition) |
These define constraints on FHIR data types for systems conforming to this implementation guide.
ExtensionInterweaveEDDischargeDestination |
An extension to record the discharge destination of patients which have attended ED. |
ExtensionInterweaveMedicallySafeForDischarge |
An extension to add information about whether medically safe for discharge to the Encounter. |
ExtensionInterweaveMedicationLastIssuedDate1 |
Indicates the last issued date for specific repeat information of a medication item. |
ExtensionInterweavePatientInstruction |
Detailed information and instructions for the patient. Pre-adopted from R4 |
ExtensionInterweaveR4EncounterServiceType |
An extension to add Service Type to the Encounter. This is pre-adopting a field that is missing in STU3 but added in R4 |
ExtensionInterweaveR4HealthcareServiceProgram |
Programs that this service is applicable to. This is pre-adopting a field that is missing in STU3 but added in R4. |
ExtensionInterweaveR4Identifier |
Business identifier for this resource |
ExtensionInterweaveR4IngredientStrength |
Quantity of ingredient present, pre-adopted from R4 |
ExtensionInterweaveR4LocationReference |
Reference to the patient’s requested location. |
ExtensionInterweaveR4ServiceType |
An extension to add UK Core Service Type to the resource. This is pre-adopting a field that is missing in STU3 but added in R4 |
ExtensionInterweaveR4UKCoreServiceType |
An extension to add UK Core Service Type to the resource. This is pre-adopting a field that is missing in STU3 but added in R4 |
ExtensionInterweaveR4ValueInteger |
An extension to add the valueInteger field, pre-adopted from R4 |
ExtensionInterweaveSexualOrientation |
An extension to add Sexual Orientation to the Patient. |
ExtensionInterweaveSocialCareAssessmentOutcome |
An extension to add a coded value for the outcome of an assessment. |
ExtensionInterweaveSocialCareAssessmentPerformer |
A reference to an practitioner which either performed, is performing or is going to perform the assessment. |
ExtensionInterweaveSocialCarePrimarySupportReason |
Flag to indicate whether this is the primary support reason |
ExtensionInterweaveSocialCareRequesterType |
An extension to add a the type of person contacting/make a request to, social care. |
ExtensionInterweaveSocialCareServiceCategory |
An extension to add a categorisation to the type of service that a person is receiving |
ExtensionInterweaveSocialCareServiceTrigger |
Reference to an assessment which triggered the start of the service. |
ExtensionInterweaveSocialCareSupportReasonPeriod |
The period during which the person received support for this support reason. |
ExtensionInterweaveSocialCareSupportRole |
An extension to add a social care support role to a RelatedPerson. |
ExtensionInterweaveValuePrecision |
Explicit precision of the number. This is the number of significant decimal places after the decimal point, irrespective of how many are actually present in the explicitly represented decimal. |
These define sets of codes used by systems conforming to this implementation guide.
AllergyIntoleranceCategory |
Category of an identified substance. |
AllergyIntoleranceType |
Identification of the underlying physiological mechanism for a Reaction Risk. |
Interweave Admission Source codes |
The source of admission to a Hospital Provider Spell or a Nursing Episode when the PATIENT is in a Hospital Site or a Care Home. Please note that the NHS Data Dictionary national codes for Source of Admission has been replaced with Admission Source. The current Valueset contains codes from both codesystems, however please use the new Interweave code system for new data provision projects. |
Interweave Discharge Destination codes |
The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. |
Interweave Document Type |
A code from the SNOMED Clinical Terminology UK coding system that describes a clinical document type. |
Interweave ED Discharge Destination |
Defines the set of codes that can be used to recording the discharge destination of patients which have attended ED. |
Interweave Flag Category |
Defines the set of codes that can be used to identify the category of flag which has been placed against a patient. |
Interweave Flag Type |
Defines the set of codes that can be used to identify the type of flag which has been placed against a patient. |
Interweave Pregnancy Estimated date of delivery Code |
Pregnancy EDD code: A selection of relevant SNOMED CT codes. |
Interweave Questionnaire Response Status |
Defines the set of codes that defines the lifecycle status of the questionnaire response. |
Interweave R4 Appointment Cancellation Reason |
Defines a set of reasons for the cancellation of an appointment. Pre-adopted from R4. |
Interweave R4 CarePlan Category Code |
Example codes indicating the category a care plan falls within. Note that these are in no way complete and might not even be appropriate for some uses. |
Interweave R4 Encounter Reason |
Defines the set of codes that can be used to indicate reasons for an encounter. Pre-adopted from R4 to gain additional codes for Social Care and A&E. |
Interweave R4 Healthcare Service Program |
This value set defines an example set of codes that could be can be used to classify groupings of service-types/specialties. Pre-adopted from R4. |
Interweave R4 Procedure Category Code |
Procedure Category code: A selection of relevant SNOMED CT codes. Pre-adoped from R4. |
Interweave Social Care Assessment Status |
This valueset uses codes from the STU3 FHIR task-status code system to indicate the status of the assessment. |
Interweave Social Care Assessment Type |
Defines the set of codes that can be used to identify the assessment type. |
Interweave Social Care Assessment outcome |
Defines the set of codes that can be used to identify the assessment outcome. These have been derived from the Event Outcome field of the V5 Adult Social Care - Client Level Data Specification |
Interweave Social Care Assessment output type |
Defines the set of codes that can be used to identify the assessment output type. These have been derived from the Event Outcome field of the V5 Adult Social Care - Client Level Data Specification |
Interweave Social Care Contact Reason |
Defines the set of codes that can be used to identify the contact reason. |
Interweave Social Care Contact Status |
This valueset uses codes from the STU3 FHIR request-status code system to indicate the status of the contact. |
Interweave Social Care Equipment Type |
Defines the set of codes that can be used to identify the type of equipment which has been placed with a person. |
Interweave Social Care Request Status |
This valueset uses codes from the STU3 FHIR request-status code system to indicate the status of the request. |
Interweave Social Care Service Status |
This valueset uses codes from the STU3 FHIR episode-of-care-status code system to indicate the status of the service. |
Interweave Social Care Support Reason |
Defines the set of codes that can be used to identify the support reason. |
Interweave Social Care Support Reason Category |
Defines the set of codes that can be used to identify the category of support reason. |
Interweave Social Care Support Reason Clinical Status |
This valueset uses codes from the STU3 FHIR condition-clinical code system to indicate the status of support reason. |
Interweave UkCore Care Service Type |
A code from the SNOMED Clinical Terminology UK coding system that describes a care setting. Pre-adoped from UKCore to use with EncounterType and AppointmentType. |
Interweave UkCore Care Setting Type |
A code from the SNOMED Clinical Terminology UK coding system that describes a care setting. Pre-adoped from UKCore to use with EncounterType and AppointmentType. |
Interweave UkCore Condition Code |
A set of codes that define a clinical finding or a finding with explicit context or an event. Selected from the SNOMED CT UK coding system. Pre-adoped from UKCore. |
Interweave UkCore Procedure Code |
A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system. Pre-adoped from UKCore. |
InterweaveAppointmentParticipantType |
This value set defines a set of codes that can be used to indicate how an individual participates in an appointment. |
InterweaveAppointmentType |
Appointment Type codes |
InterweaveCodesCharacteristicServiceMode |
An example set of Service Modes that could be applicable to use to characterize HealthcareServices or PractitionerRoles. |
InterweaveEncounterClass |
Encounter Class codes |
InterweaveEncounterPriority |
Encounter priority codes |
InterweaveEpisodeOfCareType |
Defines the set of EpisodeOfCare Type codes |
InterweaveMedicallySafeForDischargeStatus |
Medically Safe For Discharge Status |
InterweaveMedicationRequestCategory |
Medication Request Category codes |
InterweaveNICIP codes |
National Interim Clinical Imaging Procedure codes |
InterweaveOrganisationType |
Organisation Types, as used by ODS |
InterweaveSexualOrientation |
Sexual Orientation, as per NHS Data Dictionary |
InterweaveSocialCareRequesterType |
The type of person making contact with social services |
InterweaveSocialCareServiceCategory |
A categorisation of the type of service that a person is receiving. |
InterweaveSocialCareServiceType |
The type of service that a person is receiving |
InterweaveSocialCareSupportRole |
The role which a person plays in a service user’s support |
InterweaveUKCorePracticeSettingCode |
A set of codes that define the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. |
Vital Signs |
This value set indicates the allowed vital sign result types. The concept Vitals signs panel (85353-1) is a grouping structure for a set of vital signs and includes related links (with type=has-member) to the Observations in this set (e.g. respiratory rate, heart rate, BP). The Blood pressure panel (85354-9) is used to group the component observations Systolic blood pressure (8480-6) and Diastolic blood pressure (8462-4). |
Vital Signs Units |
Common UCUM units for recording Vital Signs |
These define new code systems used by systems conforming to this implementation guide.
Interweave Admission Source codes |
The source of admission to a Hospital Provider Spell or a Nursing Episode when the PATIENT is in a Hospital Site or a Care Home. |
Interweave Discharge Destination codes |
The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. |
Interweave R4 Appointment Cancellation Reason |
Defines a set of reasons for the cancellation of an appointment. Pre-adopted from R4. |
InterweaveAppointmentType |
Additional Appointment Type codes |
InterweaveEncounterClass |
Additional Encounter Class codes |
InterweaveEncounterPriority |
Additional Encounter Priority codes |
InterweaveEpisodeOfCareType |
EpisodeOfCare Type codes |
InterweaveMedicallySafeForDischargeStatus |
Medically Safe For Discharge Status |
InterweaveMedicationRequestCategory |
Additional Medication Request Category codes |
InterweaveNICIP codes |
National Interim Clinical Imaging Procedure codes |
InterweaveOrganisationType |
Organisation Types, as used by ODS |
InterweaveSexualOrientation |
Sexual Orientation, as per NHS Data Dictionary |
InterweaveSocialCareAssessmentOutcome |
The social care assessment outcome. |
InterweaveSocialCareAssessmentOutputType |
The social care assessment output type. |
InterweaveSocialCareAssessmentType |
The social care assessment type. |
InterweaveSocialCareContactReason |
The social care contact reason. |
InterweaveSocialCareFlagCategory |
The categorisation of social care flags which can be placed against a person. |
InterweaveSocialCareFlagType |
The type of social care flag which can be placed against a person. |
InterweaveSocialCareRequesterType |
The type of person making contact with social services |
InterweaveSocialCareServiceCategory |
A categorisation of the type of service that a person is receiving. |
InterweaveSocialCareServiceType |
The type of service that a person is receiving |
InterweaveSocialCareSupportReason |
The social care support reason. |
InterweaveSocialCareSupportReasonCategory |
The categorisation of the social care support reason. |
InterweaveSocialCareSupportRole |
The role which a person plays in a service user’s support |
InterweaveUKCorePracticeSettingCode |
A set of codes that define the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
InterweaveAllergyIntoleranceExample-Drug |
Interweave AllergyIntolerance Example - Drug Allergy |
InterweaveAllergyIntoleranceExample-Food |
Interweave AllergyIntolerance Example - Food Allergy |
InterweaveAllergyIntoleranceExample-NKA |
Interweave AllergyIntolerance Example - No Known Allergy |
InterweaveAppointmentExample |
Interweave Appointment example |
InterweaveDiagnosticReportBasicExample |
Interweave Diagnostic Report - basic example |
InterweaveDocumentReferenceExample |
Interweave Document Reference example |
InterweaveEncounterExample-MaturityLevel1 |
Interweave Encounter example - Maturity Level 1 (no grouping) |
InterweaveEncounterExample-MaturityLevel2-Part1 |
Interweave Encounter example - Maturity Level 2 (part 1 of grouping) |
InterweaveEncounterExample-MaturityLevel2-Part2 |
Interweave Encounter example - Maturity Level 2 (part 2 of grouping) |
InterweaveEncounterGroupingExample |
Interweave Encounter Grouping example |
InterweaveFlagExample-Full |
Interweave Flag Example - Full |
InterweaveFlagExample-MustSupport |
Interweave Flag Example - Must Support |
InterweaveLocationBuildingExample |
Interweave Location example - Building |
InterweaveLocationHouseExample |
Interweave Location example - House |
InterweaveLocationRoomExample |
Interweave Location example - Room |
InterweaveLocationSiteExample |
Interweave Location example - Site |
InterweaveLocationSocialCareExample |
Interweave Location example - Care Home |
InterweaveLocationWardExample1 |
Interweave Location example - Ward 27 |
InterweaveLocationWardExample2 |
Interweave Location example - Ward 28 |
InterweaveLocationWardExampleAandE |
Interweave Location example - A&E |
InterweaveMedicationExample |
Interweave Medication Example |
InterweaveObservationBloodPressureExample |
Interweave Observation BloodPressure Example |
InterweaveObservationBodyTemperatureExample |
Interweave Observation BodyTemperature Example |
InterweaveObservationHeartRateExample-Full |
Interweave Observation HeartRate Example |
InterweaveObservationRespiratoryRateExample |
Interweave Observation RespiratoryRate Example |
InterweaveOperationOutcomeExample |
Interweave Operation Outcome example |
InterweaveOrganizationExample |
Interweave Organization example |
InterweaveOrganizationExampleSocialCare |
Interweave Organization Social Care example |
InterweaveOrganizationalTeamExampleFull |
Interweave Organizational Team example - Full |
InterweaveOrganizationalTeamExampleMS |
Interweave Organizational Team example - Must Support |
InterweavePatientExample-Full |
Interweave Patient example - Full |
InterweavePatientExample-MustSupport |
Interweave Patient example - Must Support |
InterweavePractitionerExample |
Interweave Practitioner example |
InterweavePractitionerRoleExample |
Interweave PractitionerRole Example |
InterweaveRelatedPersonExample-Full |
Interweave Related Person - Full - Example |
InterweaveRelatedPersonExample-SocialCare-Full |
Interweave Related Person - Social Care - Full - Example |
InterweaveRelatedPersonExample-SocialCare-MustSupport |
Interweave Related Person - Social Care - Must Support - Example |
InterweaveSocialCareServiceExample-Full |
Interweave Social Care Service example - Full |
InterweaveSocialCareServiceExample-MustSupport |
Interweave Social Care Service example - Must Support |
InterweaveSocialCareSupportReasonExample-Full |
Interweave Social Care Support Reason (FHIR Condition) example - Full |
InterweaveSocialCareSupportReasonExample-MS |
Interweave Social Care Support Reason (FHIR Condition) example - Must Support |