@haste-health/fhir-types 0.12.1

package/lib/generated/r4b/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/generated/r4b/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/generated/r4b/types.ts"],"names":[],"mappings":""}

package/lib/versions.d.ts

@@ -0,0 +1,19 @@
+import * as r4 from "./generated/r4/types.js";
+import * as r4b from "./generated/r4b/types.js";
+export type R4 = "4.0";
+export type R4B = "4.3";
+export declare const R4: R4;
+export declare const R4B: R4B;
+export declare const FHIR_VERSIONS_SUPPORTED: [R4, R4B];
+export type FHIR_VERSION = (typeof FHIR_VERSIONS_SUPPORTED)[number];
+type ResourceTypeMap = {
+    [R4]: r4.ResourceType;
+    [R4B]: r4b.ResourceType;
+};
+export type ResourceType<Version extends (typeof FHIR_VERSIONS_SUPPORTED)[number]> = ResourceTypeMap[Version];
+export type AllResourceTypes = ResourceType<FHIR_VERSION>;
+export type Resource<Version extends (typeof FHIR_VERSIONS_SUPPORTED)[number], Type extends AllResourceTypes> = Version extends R4 ? Type extends r4.ResourceType ? r4.AResource<Type> : never : Version extends R4B ? Type extends r4b.ResourceType ? r4b.AResource<Type> : never : never;
+export type DataType<Version extends (typeof FHIR_VERSIONS_SUPPORTED)[number]> = Version extends R4 ? r4.DataType : Version extends R4B ? r4b.DataType : never;
+export type AllDataTypes = r4.DataType | r4b.DataType;
+export type Data<Version extends (typeof FHIR_VERSIONS_SUPPORTED)[number], Type extends AllDataTypes> = Version extends R4 ? Type extends r4.DataType ? r4.AData<Type> : never : Version extends R4B ? Type extends r4b.DataType ? r4b.AData<Type> : never : never;
+export {};

package/lib/versions.js

@@ -0,0 +1,5 @@
+export const R4 = "4.0";
+export const R4B = "4.3";
+export const FHIR_VERSIONS_SUPPORTED = [R4, R4B];
+// ------------------------------------------------------------------------------------------------
+//# sourceMappingURL=versions.js.map

package/lib/versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../src/versions.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,EAAE,GAAO,KAAK,CAAC;AAC5B,MAAM,CAAC,MAAM,GAAG,GAAQ,KAAK,CAAC;AAE9B,MAAM,CAAC,MAAM,uBAAuB,GAAc,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;AAgD5D,mGAAmG"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@haste-health/fhir-types",
+  "version": "0.12.1",
+  "homepage": "https://haste.health",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HasteHealth/HasteHealth.git"
+  },
+  "description": "",
+  "type": "module",
+  "scripts": {
+    "generate-r4": "pnpm node ../cli/lib/hastehealth.js generate types-artifacts --version=4.0 --output=./src/generated/r4 && pnpm build",
+    "generate-r4b": "pnpm node ../cli/lib/hastehealth.js generate types-artifacts --version=4.3 --output=./src/generated/r4b && pnpm build",
+    "generate": "pnpm generate-r4 && pnpm generate-r4b",
+    "build": "tsc",
+    "publish": "pnpm build && pnpm npm publish --access public --tolerate-republish"
+  },
+  "types": "lib/r4/types.d.ts",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "exports": {
+    "./versions": "./lib/versions.js",
+    "./lib/generated/r4/types": "./lib/generated/r4/types.js",
+    "./lib/generated/r4/sets": "./lib/generated/r4/sets.js",
+    "./lib/generated/r4b/types": "./lib/generated/r4b/types.js",
+    "./lib/generated/r4b/sets": "./lib/generated/r4b/sets.js",
+    "./lib/versions": "./lib/versions.js",
+    "./r4/sets": "./lib/generated/r4/sets.js",
+    "./r4/types": "./lib/generated/r4/types.js",
+    "./r4b/sets": "./lib/generated/r4b/sets.js",
+    "./r4b/types": "./lib/generated/r4b/types.js"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.17",
+    "typescript": "5.9.2"
+  },
+  "files": [
+    "readme.md",
+    "types/**",
+    "lib/**",
+    "src/**"
+  ]
+}

package/readme.md

@@ -0,0 +1,103 @@
+# FHIR Typescript Types
+
+Typescript types generated off of FHIR StructureDefinitions.
+
+## Usage
+
+```typescript
+import { Observation, Patient, id } from "@haste-health/fhir-types/r4/types";
+
+const patient: Patient = {
+  name: [
+    {
+      use: "official",
+      given: ["Eve"],
+      family: "Williams",
+    },
+  ],
+  active: true,
+  gender: "female",
+  address: [
+    {
+      use: "home",
+      line: ["2222 Home Street"],
+    },
+  ],
+  telecom: [
+    {
+      use: "work",
+      value: "555-555-2003",
+      system: "phone",
+    },
+  ],
+  birthDate: "1973-05-31",
+  identifier: [
+    {
+      type: {
+        coding: [
+          {
+            code: "SS",
+            system: "http://terminology.hl7.org/CodeSystem/v2-0203",
+          },
+        ],
+      },
+      value: "444222222",
+      system: "http://hl7.org/fhir/sid/us-ssn",
+    },
+  ],
+  resourceType: "Patient",
+  managingOrganization: {
+    reference: "Organization/hl7",
+  },
+};
+```
+
+## Sets
+
+Sets can be used to determine whether a type is a resource, primitive or complex type.
+These are utilities that can be useful
+
+| name           | description                                                      |
+| -------------- | ---------------------------------------------------------------- |
+| resourceTypes  | String set of FHIR resource types                                |
+| complexTypes   | String set of FHIR complex types (HumanName, Identifier etc...). |
+| primitiveTypes | String set of FHIR primitive types (string, id, decimal etc...). |
+
+### Usage
+
+```typescript
+import {
+  primitiveTypes,
+  resourceTypes,
+} from "@haste-health/fhir-types/r4/sets";
+
+function isPrimitiveType(type: string) {
+  returnprimitiveTypes.has(type);
+}
+function isResourceType(type: string) {
+  returnresourceTypes.has(type);
+}
+```
+
+## Utility Types
+
+Various utility types generally used for Typescript generic functions.
+
+| Name         | Description                                                                                                                            |
+| ------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
+| ResourceType | One of the resourcetypes, ie "Patient", "Observation".                                                                                 |
+| AResource    | Generic type with an argument of ResourceType, when passed in, returns an instance of ResourceType IE AResource\<"Patient"\> = Patient |
+| Resource     | An instance of one of the resource types                                                                                               |
+
+### Example
+
+Pulled from @haste-health/client this example passes in an argument of ResourceType
+which is a string of only allowed ResourceTypes and using AResource returns an object in conformance with the type passed in.
+
+```typescript
+read<T extends ResourceType>(
+ctx: CTX,
+resourceType: T,
+id: id
+): Promise<AResource<T> | undefined>;
+```

package/src/generated/r4/sets.ts

@@ -0,0 +1,6 @@
+export const resourceTypes: Set<string>  = new Set(["Resource","Account","ActivityDefinition","AdverseEvent","AllergyIntolerance","Appointment","AppointmentResponse","AuditEvent","Basic","Binary","BiologicallyDerivedProduct","BodyStructure","Bundle","CapabilityStatement","CarePlan","CareTeam","CatalogEntry","ChargeItem","ChargeItemDefinition","Claim","ClaimResponse","ClinicalImpression","CodeSystem","Communication","CommunicationRequest","CompartmentDefinition","Composition","ConceptMap","Condition","Consent","Contract","Coverage","CoverageEligibilityRequest","CoverageEligibilityResponse","DetectedIssue","Device","DeviceDefinition","DeviceMetric","DeviceRequest","DeviceUseStatement","DiagnosticReport","DocumentManifest","DocumentReference","DomainResource","EffectEvidenceSynthesis","Encounter","Endpoint","EnrollmentRequest","EnrollmentResponse","EpisodeOfCare","EventDefinition","Evidence","EvidenceVariable","ExampleScenario","ExplanationOfBenefit","FamilyMemberHistory","Flag","Goal","GraphDefinition","Group","GuidanceResponse","HealthcareService","ImagingStudy","Immunization","ImmunizationEvaluation","ImmunizationRecommendation","ImplementationGuide","InsurancePlan","Invoice","Library","Linkage","List","Location","Measure","MeasureReport","Media","Medication","MedicationAdministration","MedicationDispense","MedicationKnowledge","MedicationRequest","MedicationStatement","MedicinalProduct","MedicinalProductAuthorization","MedicinalProductContraindication","MedicinalProductIndication","MedicinalProductIngredient","MedicinalProductInteraction","MedicinalProductManufactured","MedicinalProductPackaged","MedicinalProductPharmaceutical","MedicinalProductUndesirableEffect","MessageDefinition","MessageHeader","MolecularSequence","NamingSystem","NutritionOrder","Observation","ObservationDefinition","OperationDefinition","OperationOutcome","Organization","OrganizationAffiliation","Parameters","Patient","PaymentNotice","PaymentReconciliation","Person","PlanDefinition","Practitioner","PractitionerRole","Procedure","Provenance","Questionnaire","QuestionnaireResponse","RelatedPerson","RequestGroup","ResearchDefinition","ResearchElementDefinition","ResearchStudy","ResearchSubject","RiskAssessment","RiskEvidenceSynthesis","Schedule","SearchParameter","ServiceRequest","Slot","Specimen","SpecimenDefinition","StructureDefinition","StructureMap","Subscription","Substance","SubstanceNucleicAcid","SubstancePolymer","SubstanceProtein","SubstanceReferenceInformation","SubstanceSourceMaterial","SubstanceSpecification","SupplyDelivery","SupplyRequest","Task","TerminologyCapabilities","TestReport","TestScript","ValueSet","VerificationResult","VisionPrescription","AccessPolicyV2","ClientApplication","IdentityProvider","Membership","Project","User"])
+
+export const complexTypes: Set<string>  = new Set(["Element","BackboneElement","Address","Age","Annotation","Attachment","CodeableConcept","Coding","ContactDetail","ContactPoint","Contributor","Count","DataRequirement","Distance","Dosage","Duration","ElementDefinition","Expression","Extension","HumanName","Identifier","MarketingStatus","Meta","Money","Narrative","ParameterDefinition","Period","Population","ProdCharacteristic","ProductShelfLife","Quantity","Range","Ratio","Reference","RelatedArtifact","SampledData","Signature","SubstanceAmount","Timing","TriggerDefinition","UsageContext"])
+
+export const primitiveTypes: Set<string>  = new Set(["base64Binary","boolean","canonical","code","date","dateTime","decimal","id","instant","integer","markdown","oid","positiveInt","string","time","unsignedInt","uri","url","uuid","xhtml"])
+