Skip to content
fhir-resource-diff

Info & list-resources

Two commands for exploring the FHIR resource landscape without leaving the terminal.

info — look up a resource type

Section titled “info — look up a resource type”
Terminal window
fhir-resource-diff info Observation --fhir-version R4
Observation (clinical)
FHIR version: R4
Measurements and assertions about a patient or subject


Documentation:
  R4:   https://hl7.org/fhir/R4/observation.html

Without --fhir-version, all versions are shown:

Terminal window
fhir-resource-diff info Patient
Patient (base)
FHIR versions: R4, R4B, R5
Documentation:
  R4:  https://hl7.org/fhir/R4/patient.html
  R4B: https://hl7.org/fhir/R4B/patient.html
  R5:  https://hl7.org/fhir/R5/patient.html

The documentation links point directly to the HL7 specification page for that resource type and version.

Bundle example

Section titled “Bundle example”
Terminal window
fhir-resource-diff info Bundle
Bundle (foundation)
FHIR versions: R4, R4B, R5
Documentation:
  R4:  https://hl7.org/fhir/R4/bundle.html
  R4B: https://hl7.org/fhir/R4B/bundle.html
  R5:  https://hl7.org/fhir/R5/bundle.html

JSON output

Section titled “JSON output”
Terminal window
fhir-resource-diff info Observation --fhir-version R4 --format json
{
  "resourceType": "Observation",
  "category": "clinical",
  "description": "Measurements and assertions about a patient or subject",
  "versions": ["R4"],
  "documentation": {
    "R4": "https://hl7.org/fhir/R4/observation.html"
  }
}

list-resources — explore the registry

Section titled “list-resources — explore the registry”
Terminal window
fhir-resource-diff list-resources --fhir-version R4
FHIR Resource Types — R4 (37 total)


foundation
  Bundle                  Container for a collection of resources
  ...


base
  Patient                 Demographics and administrative information about an individual
  Practitioner            A person with a formal responsibility in healthcare
  Organisation            A formally recognised grouping of people or organisations
  ...


clinical
  Observation             Measurements and assertions about a patient or subject
  Condition               Detailed information about a clinical condition or diagnosis
  MedicationRequest       Order or request for a medication
  AllergyIntolerance      Allergy or intolerance and its clinical consequences
  ...


financial
  Claim                   Claim, pre-determination, or pre-authorisation
  Coverage                Insurance or medical plan coverage
  ExplanationOfBenefit    Explanation of Benefit resource

Filter by category

Section titled “Filter by category”
Terminal window
fhir-resource-diff list-resources --category clinical
fhir-resource-diff list-resources --category financial
fhir-resource-diff list-resources --category foundation

Available categories: foundation, base, clinical, financial, specialized, conformance.

Filter by FHIR version

Section titled “Filter by FHIR version”
Terminal window
fhir-resource-diff list-resources --fhir-version R5

Lists only resource types present in R5. Useful for checking which types are available before validating version-specific resources.

JSON output

Section titled “JSON output”
Terminal window
fhir-resource-diff list-resources --fhir-version R5 --format json

Returns an array of resource type objects with name, category, description, and documentation fields — useful for tooling that needs to enumerate or validate against the registry.

See also

Section titled “See also”