npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

@synanetics/constants

v6.3.0

Published

A collection of constants.

Downloads

3,669

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

sarah-gibsonsarah-gibsonwhay-synwhay-synsynjysynjysynstevesynstevedanielpeterbayleydanielpeterbayleytom-synaneticstom-synaneticsgregsynaneticsgregsynaneticswrobinsonsynaneticswrobinsonsynaneticssynrichardbrownsynrichardbrownleecampbellsynaneticsleecampbellsynaneticsluke-synluke-synedward-synaneticsedward-synaneticsaviwsynaneticsaviwsynaneticsalexwhitmanalexwhitman

Keywords

Readme

@synanetics/constants

A collection of frequently used constants.

Example Usage (simple enums)

const {
  FhirCodeSystem,
  FhirIdentifierSystem,
  FhirValueSetOperationOutcomeSTU3,
  HL7CodeSystem,
  HL7HttpHeader,
  InterweaveFhirSystem,
  InterweaveHttpHeader,
  InterweaveAccessReason,
  InterweaveUserRole,
  InterweaveResourceProfileSTU3,
  HL7ResourceProfileCareConnectSTU3,
  HL7ExtensionDefinition,
  InterweaveExtensionDefinition,
  HL7FhirSystem,
  HL7ResourceProfile,
  HL7ResourceProfileUKCore,
  HL7ExtensionDefinitionCareConnect,
  HL7ExtensionDefinitionUKCore,
  NHSWalesFhir,
  NHSWalesCodeSystem,
  NHSWalesExtension,
  BCUHBCodeSystem,
  BCUHBExtension,
} = require('@synanetics/constants');
// or
import {
  FhirCodeSystem,
  FhirIdentifierSystem,
  FhirValueSetOperationOutcomeSTU3,
  HL7CodeSystem,
  HL7HttpHeader,
  InterweaveFhirSystem,
  InterweaveHttpHeader,
  InterweaveAccessReason,
  InterweaveUserRole,
  InterweaveResourceProfileSTU3,
  HL7ResourceProfileCareConnectSTU3,
  HL7ExtensionDefinition,
  InterweaveExtensionDefinition,
  HL7FhirSystem,
  HL7ResourceProfile,
  HL7ResourceProfileUKCore,
  HL7ExtensionDefinitionCareConnect,
  HL7ExtensionDefinitionUKCore,
  NHSWalesFhir,
  NHSWalesCodeSystem,
  NHSWalesExtension,
  BCUHBCodeSystem,
  BCUHBExtension,
} from '@synanetics/constants';

Example usage (object enums)

Object enums for entire Codings have been included for some more-recently added constants, in order to simplify the declaration of Coding/CodeableConcept properties:

import { InterweaveAuditEventTypeCoding } from '@synanetics/constants';

const auditEventUsingCodingEnum = {
  resourceType: 'AuditEvent',
  type: InterweaveAuditEventTypeCoding.AUTHENTICATION_REQUEST.value,
  // ... other properties
};

This is equivalent to the below:

import { InterweaveAuditEventType, InterweaveFhirSystem } from '@synanetics/constants';

const auditEventWithoutUsingCodingEnum = {
  resourceType: 'AuditEvent',
  type: {
    code: InterweaveAuditEventType.AUTHENTICATION_REQUEST,
    system: InterweaveFhirSystem.AUDIT_EVENT_TYPE,
    display: 'Authentication Request',
  }
};

Constants

The package provides the following definitions:

HL7HttpHeader

HL7 defined extension header to prevent the creation of duplicate resources

| Constant | | --------------------------- | | HL7HttpHeader.IF_NONE_EXIST |

HL7ResourceProfile

HL7 Resource Profile URLs for use in resource meta.profile

| Constant | | ------------------------------ | | HL7ResourceProfile.APPOINTMENT | | HL7ResourceProfile.SCHEDULE | | HL7ResourceProfile.SLOT |

HL7ExtensionDefinitionUKCore

HL7 UK Core Extensions for resources

| Constants | | --------------------------------------------- | | HL7ExtensionDefinitionUKCore.CONTACT_RANK | | HL7ExtensionDefinitionUKCore.DELIVERY_CHANNEL |

HL7ResourceProfileUKCore

HL7 UK Core Resource Profile URLs for use in resource meta.profile

| Constant | | ------------------------------------ | | HL7ResourceProfileUKCore.APPOINTMENT | | HL7ResourceProfileUKCore.ENCOUNTER | | HL7ResourceProfileUKCore.SCHEDULE | | HL7ResourceProfileUKCore.SLOT |

HL7ResourceProfileCareConnectSTU3

Care Connect Resource Profile URLs for use in STU3 resource meta.profile

| Constant | | --------------------------------------------------------------- | | HL7ResourceProfileCareConnectSTU3.ALLERGY_INTOLERANCE | | HL7ResourceProfileCareConnectSTU3.APPOINTMENT | | HL7ResourceProfileCareConnectSTU3.CARE_PLAN | | HL7ResourceProfileCareConnectSTU3.CARE_TEAM | | HL7ResourceProfileCareConnectSTU3.COMMUNICATION | | HL7ResourceProfileCareConnectSTU3.COMPOSITION | | HL7ResourceProfileCareConnectSTU3.CONDITION | | HL7ResourceProfileCareConnectSTU3.CONDITION_PROBLEM_HEADER | | HL7ResourceProfileCareConnectSTU3.CONSENT | | HL7ResourceProfileCareConnectSTU3.CONTRACT | | HL7ResourceProfileCareConnectSTU3.DIAGNOSTIC_REPORT | | HL7ResourceProfileCareConnectSTU3.DOCUMENT_REFERENCE | | HL7ResourceProfileCareConnectSTU3.ENCOUNTER | | HL7ResourceProfileCareConnectSTU3.EPISODE_OF_CARE | | HL7ResourceProfileCareConnectSTU3.FAMILY_MEMBER_HISTORY | | HL7ResourceProfileCareConnectSTU3.FLAG | | HL7ResourceProfileCareConnectSTU3.FLAG_MEDICATION | | HL7ResourceProfileCareConnectSTU3.HEALTHCARE_SERVICE | | HL7ResourceProfileCareConnectSTU3.IMMUNIZATION | | HL7ResourceProfileCareConnectSTU3.LIST | | HL7ResourceProfileCareConnectSTU3.LIST_PROBLEM | | HL7ResourceProfileCareConnectSTU3.LOCATION | | HL7ResourceProfileCareConnectSTU3.MEDICATION | | HL7ResourceProfileCareConnectSTU3.MEDICATION_ADMINISTRATION | | HL7ResourceProfileCareConnectSTU3.MEDICATION_DISPENSE | | HL7ResourceProfileCareConnectSTU3.MEDICATION_REQUEST | | HL7ResourceProfileCareConnectSTU3.MEDICATION_STATEMENT | | HL7ResourceProfileCareConnectSTU3.OBSERVATION | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_ACVPU | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_AVCPU | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_BLOOD_PRESSURE | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_BODY_TEMPERATURE | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_HEART_RATE | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_INSPIRED_OXYGEN | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_OXYGEN_SATURATION | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_RESPIRATORY_RATE | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_SUBSCORE | | HL7ResourceProfileCareConnectSTU3.OBSERVATION_VITAL_SIGNS | | HL7ResourceProfileCareConnectSTU3.ORGANIZATION | | HL7ResourceProfileCareConnectSTU3.PATIENT | | HL7ResourceProfileCareConnectSTU3.PRACTITIONER | | HL7ResourceProfileCareConnectSTU3.PRACTITIONER_ROLE | | HL7ResourceProfileCareConnectSTU3.PROCEDURE | | HL7ResourceProfileCareConnectSTU3.PROCEDURE_REQUEST | | HL7ResourceProfileCareConnectSTU3.QUANTITY | | HL7ResourceProfileCareConnectSTU3.QUESTIONNAIRE | | HL7ResourceProfileCareConnectSTU3.QUESTIONNAIRE_RESPONSE | | HL7ResourceProfileCareConnectSTU3.REFERRAL_REQUEST | | HL7ResourceProfileCareConnectSTU3.RELATED_PERSON | | HL7ResourceProfileCareConnectSTU3.RESEARCH_STUDY | | HL7ResourceProfileCareConnectSTU3.RISK_ASSESSMENT | | HL7ResourceProfileCareConnectSTU3.SCHEDULE | | HL7ResourceProfileCareConnectSTU3.SLOT | | HL7ResourceProfileCareConnectSTU3.SPECIMEN | | HL7ResourceProfileCareConnectSTU3.TASK |

HL7ExtensionDefinition

HL7 Extension URLs

| Constant | | --------------------------------------------------------------------------- | | HL7ExtensionDefinition.IMMUNIZATION_NOT_GIVEN | | HL7ExtensionDefinition.IMMUNIZATION_VACCINATION_PROTOCOL_DESCRIPTION | | HL7ExtensionDefinition.IMMUNIZATION_VACCINATION_PROTOCOL_DOSE_STATUS | | HL7ExtensionDefinition.IMMUNIZATION_VACCINATION_PROTOCOL_DOSE_STATUS_REASON | | HL7ExtensionDefinition.MEDICATION_ADMINISTRATION_NOT_GIVEN | | HL7ExtensionDefinition.MEDICATION_ADMINISTRATION_PERFORMER_ON_BEHALF_OF | | HL7ExtensionDefinition.MEDICATION_ADMINISTRATION_STATUS | | HL7ExtensionDefinition.MEDICATION_STATEMENT_STATUS | | HL7ExtensionDefinition.MEDICATION_STATEMENT_TAKEN | | HL7ExtensionDefinition.OBSERVATION_INTERFERED_BY | | HL7ExtensionDefinition.OBSERVATION_QUALIFIED_BY | | HL7ExtensionDefinition.OBSERVATION_REPLACES | | HL7ExtensionDefinition.OBSERVATION_SEQUEL_TO | | HL7ExtensionDefinition.RENDERED_VALUE |

HL7ExtensionDefinitionCareConnect

Care Connect Extension URLs

| Constant | | ---------------------------------------------------------------- | | HL7ExtensionDefinitionCareConnect.DELIVERY_CHANNEL | | HL7ExtensionDefinitionCareConnect.NHS_NUMBER_VERIFICATION_STATUS |

HL7CodeSystem

HL7 defined code system url for use in FhirResource.extension

| Constant | | ---------------------------------------------- | | HL7CodeSystem.ACT_CODE | | HL7CodeSystem.ALLERGY_INTOLERANCE_CLINICAL | | HL7CodeSystem.ALLERGY_INTOLERANCE_VERIFICATION | | HL7CodeSystem.APPOINTMENT_REASON | | HL7CodeSystem.ROLE_CODE | | HL7CodeSystem.PARTICIPANT_TYPE | | HL7CodeSystem.OBSERVATION_CATEGORY |

HL7CodeSystemCareConnect

Care Connect code system urls

| Constant | | ------------------------------------------------------- | | HL7CodeSystemCareConnect.NHS_NUMBER_VERIFICATION_STATUS |

HL7FhirSystem

HL7 defined system url for use as system

| Constant | | ----------------------------------- | | HL7FhirSystem.ACT_CODE | | HL7FhirSystem.NAMING | | HL7FhirSystem.OBSERVATION_CATEGORY | | HL7FhirSystem.ORGANIZATION_TYPE | | HL7FhirSystem.PARTICIPATION_TYPE | | HL7FhirSystem.PARTICIPATION_TYPE_V3 | | HL7FhirSystem.REQUEST_INTENT |

HL7NhsNumberVerificationStatus

HL7 NHS Number Verification Status Coding.code enum for system https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1

| Constant | Value | | ---------------------------------------------------- | ----- | | HL7NhsNumberVerificationStatus.PRESENT_AND_VERIFIED | 01 | | HL7NhsNumberVerificationStatus.PRESENT_NOT_TRACED | 02 | | HL7NhsNumberVerificationStatus.TRACE_REQUIRED | 03 | | HL7NhsNumberVerificationStatus.TRACE_ATTEMPTED | 04 | | HL7NhsNumberVerificationStatus.TRACE_NEEDS_RESOLVING | 05 | | HL7NhsNumberVerificationStatus.TRACE_IN_PROGRESS | 06 | | HL7NhsNumberVerificationStatus.TRACE_NOT_REQUIRED | 07 | | HL7NhsNumberVerificationStatus.TRACE_POSTPONED | 08 |

InterweaveHttpHeader

| Constant | Description | | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | InterweaveHttpHeader.DATA_PROVIDER_WAIT_TIME | Custom Interweave FHIR header presenting a the time for which a query should wait before timing out when searching the FHIRStore | | InterweaveHttpHeader.RESOURCE_EXPIRY_TIMESTAMP | Custom Interweave FHIR header presenting a future date in ISO_8601 format after which a resource will be expunged from a FHIRStore - passed when creating or updating a resource | | InterweaveHttpHeader.RESOURCE_EXPIRY_TTL | Custom Interweave FHIR header presenting a duration in ISO_8601 format after which a resource will be expunged from a FHIRStore - passed when creating or updating a resource | | InterweaveHttpHeader.RETENTION_ERASE_TIMESTAMP | Custom Interweave FHIR header presenting a future date in ISO_8601 format after which retention history will be expunged from a FHIRStore - passed when deleting a resource | | InterweaveHttpHeader.RETENTION_ERASE_TTL | Custom Interweave FHIR header presenting a duration in ISO_8601 format after which retention history will be expunged from a FHIRStore - passed when deleting a resource | | InterweaveHttpHeader.ALLOW_INVALID_RESOURCES | Custom Interweave FHIR header allowing invalid resources when making a FHIR request | | InterweaveHttpHeader.ALLOW_LOCAL_RESOURCES | Custom Interweave FHIR header allowing local resources when making a FHIR request |

InterweaveFhirSystem

| Constant | Description | | --------------------------------------------------------- | ------------------------------------------------------ | | InterweaveFhirSystem.ACT_CODE | Encounter class code system | | InterweaveFhirSystem.ORGANIZATION_TYPE | Organization type code system | | InterweaveFhirSystem.PARTICIPANT_ID | Organization Participant Id based system | | InterweaveFhirSystem.PROVENANCE_TAG | Provenance system for meta tag | | InterweaveFhirSystem.REFRESH_TAG | Tag system to denote a last refresh for a resource | | InterweaveFhirSystem.SOURCE_TAG | Source system for meta tag | | InterweaveFhirSystem.SUBSCRIPTION_PATIENT_ID | Subscription Patient Id based system | | InterweaveFhirSystem.TYPE_TAG | Tag system to denote a type of resource | | InterweaveFhirSystem.LOCAL_IDENTIFIER_APPOINTMENT | Identifier system for local system use | | InterweaveFhirSystem.LOCAL_IDENTIFIER_ENCOUNTER | Identifier system for local system use | | InterweaveFhirSystem.LOCAL_IDENTIFIER_PATIENT | Identifier system for local system use | | InterweaveFhirSystem.LOCAL_IDENTIFIER_SCHEDULE | Identifier system for local system use | | InterweaveFhirSystem.LOCAL_IDENTIFIER_SERVICE_REQUEST | Identifier system for local system use | | InterweaveFhirSystem.LOCAL_IDENTIFIER_SLOT | Identifier system for local system use | | InterweaveFhirSystem.AUDIT_EVENT_TYPE | Extension of FHIR AuditEvent type codes | | InterweaveFhirSystem.AUDIT_EVENT_SUBTYPE | Extension of FHIR AuditEvent subtype codes | | InterweaveFhirSystem.AUDIT_EVENT_OUTCOME | Extension of FHIR AuditEvent outcome codes | | InterweaveFhirSystem.AUDIT_AGENT_ROLE | Extension of FHIR AuditEvent agent role codes | | InterweaveFhirSystem.AUDIT_ENTITY_TYPE | Extension of FHIR AuditEvent entity type codes | | InterweaveFhirSystem.AUDIT_PURPOSE_OF_USE | Extension of FHIR AuditEvent purpose of use codes | | InterweaveFhirSystem.SERVICE_REQUEST_BARS_REFERRAL_TYPE | ServiceRequest BaRS referral type CodeSystem | | InterweaveFhirSystem.SERVICE_REQUEST_BARS_BOOKING_STATUS | ServiceRequest BaRS referral booking status CodeSystem | | InterweaveFhirSystem.OPERATION_OUTCOME_DETAIL_PIX_FAILURE | OperationOutcome PIX failure status CodeSystem | | InterweaveFhirSystem.PIX_REGISTRATION_STATUS | Meta tag CodeSystem for PIX registration status | | InterweaveFhirSystem.PIX_REGISTRATION_ISSUE_CODE | Patient contained OperationOutcome issue CodeSystem |

InterweaveResourceProfileSTU3

Interweave defined structure definition url for use as meta.profile

| Constant | | -------------------------------------------------------- | | InterweaveResourceProfileSTU3.ALLERGY_INTOLERANCE | | InterweaveResourceProfileSTU3.APPOINTMENT | | InterweaveResourceProfileSTU3.CARE_PLAN | | InterweaveResourceProfileSTU3.DEVICE_REQUEST_SOCIAL_CARE | | InterweaveResourceProfileSTU3.ENCOUNTER | | InterweaveResourceProfileSTU3.EPISODE_OF_CARE | | InterweaveResourceProfileSTU3.OBSERVATION | | InterweaveResourceProfileSTU3.OBSERVATION_BLOOD_PRESSURE | | InterweaveResourceProfileSTU3.OBSERVATION_HEIGHT | | InterweaveResourceProfileSTU3.OBSERVATION_PREGNANCY_EDD | | InterweaveResourceProfileSTU3.OBSERVATION_WEIGHT | | InterweaveResourceProfileSTU3.ORGANIZATION | | InterweaveResourceProfileSTU3.PRACTITIONER | | InterweaveResourceProfileSTU3.PROCEDURE | | InterweaveResourceProfileSTU3.QUESTIONNAIRE_RESPONSE | | InterweaveResourceProfileSTU3.REFERRAL_REQUEST | | InterweaveResourceProfileSTU3.RELATED_PERSON |

InterweaveExtensionDefinition

Interweave defined structure definition url for use in extensions

| Constant | | ----------------------------------------------------------------- | | InterweaveExtensionDefinition.ENCOUNTER_SERVICE_TYPE | | InterweaveExtensionDefinition.SCHEDULE_TOTAL_SLOTS | | InterweaveExtensionDefinition.SERVICE_REQUEST_BARS_REFERRAL_TYPE | | InterweaveExtensionDefinition.SERVICE_REQUEST_BARS_BOOKING_STATUS | | InterweaveExtensionDefinition.BARS_MESSAGE_BUNDLE_REFERENCE |

InterweaveAccessReason

Descriptive enum of access reasons and related values.

| Constant | Value | | ---------------------------------------------------- | ----- | | InterweaveAccessReason.DIRECT_CARE_EMERGENCY | 1.1 | | InterweaveAccessReason.DIRECT_CARE_NON_EMERGENCY | 1.2 | | InterweaveAccessReason.INDIRECT_CARE_CONSENT_PATIENT | 2 | | InterweaveAccessReason.INDIRECT_CARE_NO_PATIENT | 3 | | InterweaveAccessReason.ANALYTICS_PSEUDONYMISED | 4 | | InterweaveAccessReason.ADMINISTRATION | 5 | | InterweaveAccessReason.PDS_TRACE | 6 | | InterweaveAccessReason.CLINICAL_SAFETY_TESTING_DATA | 7.1 | | InterweaveAccessReason.CLINICAL_SAFETY_TESTING_UI | 7.2 |

InterweaveUserRole

Descriptive enum of user roles and related values.

| Constant | Value | | ------------------------------------------- | ----- | | InterweaveUserRole.NATIONAL_ROLE4 | 1 | | InterweaveUserRole.SOCIAL_CARE_PROFESSIONAL | 2 | | InterweaveUserRole.CITIZEN | 3 | | InterweaveUserRole.SYSTEM_OR_ROBOT | 4 | | InterweaveUserRole.ADMINISTRATOR | 5 | | InterweaveUserRole.AUDITOR | 6 | | InterweaveUserRole.AUTHORISED_CARER | 7 | | InterweaveUserRole.NATIONAL_ROLE1 | 8 | | InterweaveUserRole.NATIONAL_ROLE2 | 9 | | InterweaveUserRole.NATIONAL_ROLE3 | 10 | | InterweaveUserRole.NATIONAL_ROLE3_PLUS | 11 | | InterweaveUserRole.NATIONAL_ROLE0 | 12 |

InterweaveAuditEventType

The allowed AuditEvent.type.code values from the ValueSet http://yhcr.nhs.net/fhir/valueset-audit-event-type, taken from section 2.3 of https://interweavedigital.com/wp-content/uploads/2024/06/YHCR-Design-Paper-009.-Auditing-v1.3.pdf

| Constant | Value | | ---------------------------------------------------- | ------- | | InterweaveAuditEventType.AUTHENTICATION_REQUEST | YHCR001 | | InterweaveAuditEventType.AUTHORIZATION_REQUEST | YHCR002 | | InterweaveAuditEventType.FHIR_OPERATION | YHCR003 | | InterweaveAuditEventType.CONTENT_RELEASED | YHCR004 | | InterweaveAuditEventType.CONTENT_WITHHELD | YHCR005 | | InterweaveAuditEventType.RESTRICTED_CONTENT_RELEASED | YHCR006 | | InterweaveAuditEventType.ASYNCHRONOUS_EVENT | YHCR007 | | InterweaveAuditEventType.SUBSCRIPTION_RESULT | YHCR008 |

InterweaveAuditEventSubType

The allowed AuditEvent.subtype.value values from the ValueSet http://yhcr.nhs.net/fhir/valueset-audit-event-sub-type, taken from section 2.3 of https://interweavedigital.com/wp-content/uploads/2024/06/YHCR-Design-Paper-009.-Auditing-v1.3.pdf.

Note that these each correspond with an AuditEvent.type, as per the comments in the code.

| Constant | Value | | --------------------------------------------------------- | -------- | | InterweaveAuditEventSubType.USER_AUTHENTICATION | YHCR0101 | | InterweaveAuditEventSubType.AUTHENTICATION_OAUTH2_REQUEST | YHCR0102 | | InterweaveAuditEventSubType.AUTHORIZATION_OAUTH2_REQUEST | YHCR0201 | | InterweaveAuditEventSubType.FHIR_OPERATION_INBOUND | YHCR0301 | | InterweaveAuditEventSubType.FHIR_OPERATION_OUTBOUND | YHCR0302 | | InterweaveAuditEventSubType.FHIR_OPERATION_MERGE | YHCR0303 | | InterweaveAuditEventSubType.FHIR_OPERATION_DELETE | YHCR0304 | | InterweaveAuditEventSubType.FHIR_OPERATION_ERASE | YHCR0305 | | InterweaveAuditEventSubType.ASYNCHRONOUS_QUERY_QUEUED | YHCR0701 | | InterweaveAuditEventSubType.ASYNCHRONOUS_PART_RECEIVED | YHCR0702 | | InterweaveAuditEventSubType.ASYNCHRONOUS_PART_RELEASED | YHCR0703 | | InterweaveAuditEventSubType.ASYNCHRONOUS_PART_PURGED | YHCR0704 | | InterweaveAuditEventSubType.SUBSCRIPTION_EXECUTED | YHCR0801 | | InterweaveAuditEventSubType.SUBSCRIPTION_RESULT_DELIVERED | YHCR0802 | | InterweaveAuditEventSubType.SUBSCRIPTION_RESULT_RECEIVED | YHCR0803 |

InterweaveAuditEventOutcome

Code values for the ValueSet http://yhcr.nhs.net/fhir/valueset-audit-event-outcome, as defined in section 2.4 of https://interweavedigital.com/wp-content/uploads/2024/06/YHCR-Design-Paper-009.-Auditing-v1.3.pdf

| Constant | Value | | ------------------------------------------- | ----- | | InterweaveAuditEventOutcome.SUCCESS | 0 | | InterweaveAuditEventOutcome.MINOR_FAILURE | 4 | | InterweaveAuditEventOutcome.SERIOUS_FAILURE | 8 | | InterweaveAuditEventOutcome.MAJOR_FAILURE | 12 | | InterweaveAuditEventOutcome.DENIED | 99 |

InterweaveAuditAgentRole

Enum of code values for the ValueSet http://yhcr.nhs.net/Coding/audit-agent-role, as defined in section 2.5 of https://interweavedigital.com/wp-content/uploads/2024/06/YHCR-Design-Paper-009.-Auditing-v1.3.pdf

| Constant | Value | | -------------------------------------- | ------------- | | InterweaveAuditAgentRole.DATA_CONSUMER | data-consumer | | InterweaveAuditAgentRole.DATA_PROVIDER | data-provider | | InterweaveAuditAgentRole.AGGREGATOR | aggregator | | InterweaveAuditAgentRole.IAM | iam |

InterweaveAuditEntityType

Enum of "audit entity type" (expansion based on http://hl7.org/fhir/audit-entity-type version 3.0.2), with inclusion of "nhs-no", as per section 2.8 of https://interweavedigital.com/wp-content/uploads/2024/06/YHCR-Design-Paper-009.-Auditing-v1.3.pdf

| Constant | Value | | --------------------------------------- | ------ | | InterweaveAuditEntityType.PERSON | 1 | | InterweaveAuditEntityType.SYSTEM_OBJECT | 2 | | InterweaveAuditEntityType.ORGANIZATION | 3 | | InterweaveAuditEntityType.OTHER | 4 | | InterweaveAuditEntityType.NHS_NUMBER | nhs-no |

InterweaveAuditPurposeOfUse

Descriptive enum of "purpose of use" and related values.

| Constant | Value | | ---------------------------------------------------- | ----- | | InterweaveAccessReason.DIRECT_CARE_EMERGENCY | 1.1 | | InterweaveAccessReason.DIRECT_CARE_NON_EMERGENCY | 1.2 | | InterweaveAccessReason.INDIRECT_CARE_CONSENT_PATIENT | 2 | | InterweaveAccessReason.INDIRECT_CARE_NO_PATIENT | 3 | | InterweaveAccessReason.ANALYTICS_PSEUDONYMISED | 4 | | InterweaveAccessReason.ADMINISTRATION | 5 |

InterweaveBarsReferralTypeCoding

FHIR CodeSystem for Interweave-R4BaRSReferralType

{
  'referral-only': {
    system: 'https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-R4BaRSReferralType',
    code: 'referral-only',
    display: 'BaRS referral with no associated booking',
  },
  'referral-with-booking': {
    system: 'https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-R4BaRSReferralType',
    code: 'referral-with-booking',
    display: 'BaRS referral with associated booking',
  },
}

InterweaveBarsReferralBookingStatusCoding

FHIR CodeSystem for Interweave-R4BaRSReferralBookingStatus

{
  'booked': {
    system: 'https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-R4BaRSReferralBookingStatus',
    code: 'booked',
    display: 'BaRS referral with associated booking - booking is booked',
  },
  'cancelled': {
    system: 'https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-R4BaRSReferralBookingStatus',
    code: 'cancelled',
    display: 'BaRS referral with associated booking - booking is cancelled',
  },
}

InterweavePixFailureStatusCoding

FHIR CodeSystem for Interweave-PIXFailureType

/**
 * {
 *    system: "https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-PIXFailureType",
 *    code: "permanent",
 *    display: "PIX has encountered a permanent error, the request must not be retried"
 * } 
 **/
InterweavePixFailureStatusCoding.PERMANENT

/**
 * {
 *    system: "https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-PIXFailureType",
 *    code: "temporary",
 *    display: "PIX has encountered a temporary error, the request may be retried"
 * } 
 **/
InterweavePixFailureStatusCoding.TEMPORARY

FhirCodeSystem

| Constant | Description | | --------------------------------------- | ------------------------------------------------ | | FhirCodeSystem.SNOMED_CT | For the SNOMED CT code system | | FhirCodeSystem.OPERATION_OUTCOME | For the operation outcome code system | | FhirCodeSystem.LOINC_ORG | For the loinc.org code system | | FhirCodeSystem.SERVICE_REQUEST_CATEGORY | For ServiceRequest category code system | | FhirCodeSystem.CONSENT_CATEGORY_BARS | For Consent category code system on BaRS message |

FhirIdentifierSystem

| Constant | Description | | -------------------------------- | ------------------------------------------------------------------ | | FhirIdentifierSystem.GMC_NUMBER | URL for the GMC (General Medical Council) number identifier system | | FhirIdentifierSystem.NHS_NUMBER | URL for the NHS number identifier system | | FhirIdentifierSystem.ODS_CODE | URL for the Organisation ODS code identifier system | | FhirIdentifierSystem.SDS_USER_ID | URL for the SDS (user account) identifier system | | FhirIdentifierSystem.ACCREDITED_SYSTEM | URL for the Accredited System ASID identifier system | | FhirIdentifierSystem.SDS_ROLE_PROFILE_ID | URL for the SDS (profile role) identifier system |

FhirValueSetOperationOutcomeSTU3

Operation outcome codes for use in STU3

| Constant | | --------------------------------------------------------------- | | FhirValueSetOperationOutcomeSTU3.MSG_AUTH_REQUIRED | | FhirValueSetOperationOutcomeSTU3.MSG_BAD_FORMAT | | FhirValueSetOperationOutcomeSTU3.MSG_BAD_SYNTAX | | FhirValueSetOperationOutcomeSTU3.MSG_CANT_PARSE_CONTENT | | FhirValueSetOperationOutcomeSTU3.MSG_CANT_PARSE_ROOT | | FhirValueSetOperationOutcomeSTU3.MSG_CREATED | | FhirValueSetOperationOutcomeSTU3.MSG_DATE_FORMAT | | FhirValueSetOperationOutcomeSTU3.MSG_DELETED | | FhirValueSetOperationOutcomeSTU3.MSG_DELETED_DONE | | FhirValueSetOperationOutcomeSTU3.MSG_DELETED_ID | | FhirValueSetOperationOutcomeSTU3.MSG_DUPLICATE_ID | | FhirValueSetOperationOutcomeSTU3.MSG_ERROR_PARSING | | FhirValueSetOperationOutcomeSTU3.MSG_ID_INVALID | | FhirValueSetOperationOutcomeSTU3.MSG_ID_TOO_LONG | | FhirValueSetOperationOutcomeSTU3.MSG_INVALID_ID | | FhirValueSetOperationOutcomeSTU3.MSG_JSON_OBJECT | | FhirValueSetOperationOutcomeSTU3.MSG_LOCAL_FAIL | | FhirValueSetOperationOutcomeSTU3.MSG_NO_MATCH | | FhirValueSetOperationOutcomeSTU3.MSG_NO_EXIST | | FhirValueSetOperationOutcomeSTU3.MSG_NO_MODULE | | FhirValueSetOperationOutcomeSTU3.MSG_NO_SUMMARY | | FhirValueSetOperationOutcomeSTU3.MSG_OP_NOT_ALLOWED | | FhirValueSetOperationOutcomeSTU3.MSG_PARAM_CHAINED | | FhirValueSetOperationOutcomeSTU3.MSG_PARAM_NO_REPEAT | | FhirValueSetOperationOutcomeSTU3.MSG_PARAM_UNKNOWN | | FhirValueSetOperationOutcomeSTU3.MSG_PARAM_INVALID | | FhirValueSetOperationOutcomeSTU3.MSG_PARAM_MODIFIER_INVALID | | FhirValueSetOperationOutcomeSTU3.MSG_RESOURCE_EXAMPLE_PROTECTED | | FhirValueSetOperationOutcomeSTU3.MSG_RESOURCE_ID_FAIL | | FhirValueSetOperationOutcomeSTU3.MSG_RESOURCE_NOT_ALLOWED | | FhirValueSetOperationOutcomeSTU3.MSG_RESOURCE_REQUIRED | | FhirValueSetOperationOutcomeSTU3.MSG_RESOURCE_ID_MISMATCH | | FhirValueSetOperationOutcomeSTU3.MSG_RESOURCE_ID_MISSING | | FhirValueSetOperationOutcomeSTU3.MSG_RESOURCE_TYPE_MISMATCH | | FhirValueSetOperationOutcomeSTU3.MSG_SORT_UNKNOWN | | FhirValueSetOperationOutcomeSTU3.MSG_TRANSACTION_DUPLICATE_ID | | FhirValueSetOperationOutcomeSTU3.MSG_TRANSACTION_MISSING_ID | | FhirValueSetOperationOutcomeSTU3.MSG_UNHANDLED_NODE_TYPE | | FhirValueSetOperationOutcomeSTU3.MSG_UNKNOWN_CONTENT | | FhirValueSetOperationOutcomeSTU3.MSG_UNKNOWN_OPERATION | | FhirValueSetOperationOutcomeSTU3.MSG_UNKNOWN_TYPE | | FhirValueSetOperationOutcomeSTU3.MSG_UPDATED | | FhirValueSetOperationOutcomeSTU3.MSG_VERSION_AWARE | | FhirValueSetOperationOutcomeSTU3.MSG_VERSION_AWARE_CONFLICT | | FhirValueSetOperationOutcomeSTU3.MSG_VERSION_AWARE_URL | | FhirValueSetOperationOutcomeSTU3.MSG_WRONG_NS | | FhirValueSetOperationOutcomeSTU3.SEARCH_MULTIPLE | | FhirValueSetOperationOutcomeSTU3.UPDATE_MULTIPLE_MATCHES | | FhirValueSetOperationOutcomeSTU3.DELETE_MULTIPLE_MATCHES | | FhirValueSetOperationOutcomeSTU3.SEARCH_NONE |

FhirValueSetNetworkTypeSTU3

Enum for ValueSet expansion based on http://hl7.org/fhir/network-type version 3.0.2

| Constant | Value | | -------------------------------------------- | ----- | | FhirValueSetNetworkTypeSTU3.MACHINE_NAME | 1 | | FhirValueSetNetworkTypeSTU3.IP_ADDRESS | 2 | | FhirValueSetNetworkTypeSTU3.TELEPHONE_NUMBER | 3 | | FhirValueSetNetworkTypeSTU3.EMAIL_ADDRESS | 4 | | FhirValueSetNetworkTypeSTU3.URI | 5 |

FhirValueSetAuditEventActionSTU3

Enum for ValueSet expansion based on http://hl7.org/fhir/audit-event-action version 3.0.2

| Constant | Value | | ---------------------------------------- | ----- | | FhirValueSetAuditEventActionSTU3.CREATE | C | | FhirValueSetAuditEventActionSTU3.READ | R | | FhirValueSetAuditEventActionSTU3.UPDATE | U | | FhirValueSetAuditEventActionSTU3.DELETE | D | | FhirValueSetAuditEventActionSTU3.EXECUTE | E |

NHSWalesFhir

Identifiers for use in Betsi Projects

| Constant | | ----------------------------------- | | NHSWalesFhir.LOCATION_IDENTIFIER | | NHSWalesFhir.CENTRAL_PAS_IDENTIFIER |

NHSWalesExtension

extensions for use in Betsi Projects

| Constant | | ----------------------------------------- | | NHSWalesExtension.HOSPITAL_CLASSIFICATION |

NHSWalesCodeSystem

Code systems defined by NHS Wales for use in Betsi Projects

| Constant | | ------------------------------------------ | | NHSWalesCodeSystem.HOSPITAL_CLASSIFICATION |

BCUHBCodeSystem

Code systems defined by us for use in Betsi Projects

| Constant | | -------------------------------- | | BCUHBCodeSystem.CARE_TEAM_ROLE | | BCUHBCodeSystem.CRN_IDENTIFIER | | BCUHBCodeSystem.ENCOUNTER_SOURCE | | BCUHBCodeSystem.PATIENT_SOURCE | | BCUHBCodeSystem.TASK_CATEGORY |

BCUHBExtension

Extensions defined by us for use in Betsi Projects

| Constant | | --------------------------------------------------- | | BCUHBExtension.ADMISSION_BED | | BCUHBExtension.ADMISSION_CLERKING | | BCUHBExtension.ADMISSION_CLERKING_CLERK | | BCUHBExtension.ADMISSION_CLERKING_PERIOD | | BCUHBExtension.ADMISSION_DISCHARGE | | BCUHBExtension.ADMISSION_OTHER_REFERRAL_TYPE | | BCUHBExtension.ADMISSION_POST_TAKE | | BCUHBExtension.ADMISSION_POST_TAKE_NOTES | | BCUHBExtension.ADMISSION_POST_TAKE_TIME | | BCUHBExtension.ADMISSION_REFERRAL_ACCEPTED_BY_BLEEP | | BCUHBExtension.ADMISSION_REFERRAL_ACCEPTED_BY_NAME | | BCUHBExtension.ADMISSION_REFERRAL_ACCEPTED_BY_TYPE | | BCUHBExtension.ADMISSION_REFERRAL_TIME | | BCUHBExtension.ADMISSION_STATUS | | BCUHBExtension.ADMISSION_TIME | | BCUHBExtension.ADMISSION_WORKLIST_DATE | | BCUHBExtension.HANDOVER_BY | | BCUHBExtension.HANDOVER_DISCHARGE_LETTER_COMPLETE | | BCUHBExtension.HANDOVER_POSSIBLE_WEEKEND_DISCHARGE | | BCUHBExtension.HANDOVER_TARGET_COMPLETION_DATE | | BCUHBExtension.HANDOVER_TO_ROLE | | BCUHBExtension.HANDOVER_TO_SHIFT | | BCUHBExtension.REFERRAL_TYPE | | BCUHBExtension.SITE_DESCRIPTION | | BCUHBExtension.SPECIALTY_ABBREV | | BCUHBExtension.SPECIALTY_ICON | | BCUHBExtension.SPECIALTY_SORT_ORDER | | BCUHBExtension.SPECIALTY_WORKLIST_DURATION | | BCUHBExtension.SPECIALTY_WORKLIST_START | | BCUHBExtension.TASK_TARGET_COMPLETION_DATE | | BCUHBExtension.TASK_TARGET_COMPLETION_SHIFT |