@synanetics/constants v6.0.0

@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

HL7ResourceProfile

HL7 Resource Profile URLs for use in resource meta.profile

HL7ExtensionDefinitionUKCore

HL7 UK Core Extensions for resources

HL7ResourceProfileUKCore

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

HL7ResourceProfileCareConnectSTU3

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

HL7ExtensionDefinition

HL7 Extension URLs

HL7ExtensionDefinitionCareConnect

Care Connect Extension URLs

HL7CodeSystem

HL7 defined code system url for use in FhirResource.extension

HL7CodeSystemCareConnect

Care Connect code system urls

HL7FhirSystem

HL7 defined system url for use as system

HL7NhsNumberVerificationStatus

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

InterweaveHttpHeader

InterweaveFhirSystem

InterweaveResourceProfileSTU3

Interweave defined structure definition url for use as meta.profile

InterweaveExtensionDefinition

Interweave defined structure definition url for use in extensions

InterweaveAccessReason

Descriptive enum of access reasons and related values.

InterweaveUserRole

Descriptive enum of user roles and related values.

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

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.

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

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

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

InterweaveAuditPurposeOfUse

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

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',
  },
}

FhirCodeSystem

FhirIdentifierSystem

FhirValueSetOperationOutcomeSTU3

Operation outcome codes for use in STU3

FhirValueSetNetworkTypeSTU3

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

FhirValueSetAuditEventActionSTU3

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

NHSWalesFhir

Identifiers for use in Betsi Projects

NHSWalesExtension

extensions for use in Betsi Projects

NHSWalesCodeSystem

Code systems defined by NHS Wales for use in Betsi Projects

BCUHBCodeSystem

Code systems defined by us for use in Betsi Projects

BCUHBExtension

Extensions defined by us for use in Betsi Projects