Structure Definitions Registry¶

Main class and utilities for managing FHIR structure definitions.

definitions ¶

Modules:

Name	Description
`registry`	Indexer for FHIR StructureDefinition bundles.

Classes:

Name	Description
`StructureDefinitionRegistry`	Registry for managing indexed StructureDefinitions.

StructureDefinitionRegistry(fhir_release: str)

Registry for managing indexed StructureDefinitions.

Methods:

Name	Description
`enable_internet_access`	Enable internet access for downloading structure definitions.
`disable_internet_access`	Disable internet access for downloading structure definitions.
`download_url`	Download JSON content from a URL.
`download_package`	Download a package from the registry and add its structure definitions to the registry.
`set_registry_base_url`	Change the package registry base URL.
`parse_canonical_url`	Parse a canonical URL to extract base URL and version.

Attributes:

Name	Type	Description
`fhir_release`	`str`	FHIR release version (e.g., "4.0.1", "4.3.0", "5.0.0").
`structure_definitions_by_url`	`Dict[str, StructureDefinition \| StructureDefinition \| StructureDefinition]`	Mapping of base URL to version to StructureDefinition instance.
`local_manifest`	`Manifest`	Manifest of local definitions

fhir_release: str = fhir_release

FHIR release version (e.g., "4.0.1", "4.3.0", "5.0.0").

structure_definitions_by_url: Dict[str, StructureDefinition | StructureDefinition | StructureDefinition] = {}

Mapping of base URL to version to StructureDefinition instance.

local_manifest: Manifest

Manifest of local definitions

enable_internet_access()

Enable internet access for downloading structure definitions.

disable_internet_access()

Disable internet access for downloading structure definitions.

download_url(url: str) -> Dict[str, Any]

Download JSON content from a URL.

download_package(package_name: str, version: str, skip_invalid: bool = False, include_dependencies: bool = True) -> None

Download a package from the registry and add its structure definitions to the registry.

set_registry_base_url(base_url: str) -> None

Change the package registry base URL.

parse_canonical_url(canonical_url: str) -> Tuple[str, Optional[str]]

Parse a canonical URL to extract base URL and version.