conformance

Documentation

Overview

Package conformance provides the FHIR Conformance Module definition.

Types within this package are raw FHIR definitions that contain relevant source information with it.

Index

• type Module
  • func DefaultModule() *Module
  • func NewModule(base string) *Module
  • func (m *Module) AddDefinition(canonical definition.Canonical, src *Source)
  • func (m *Module) All() []definition.Canonical
  • func (m *Module) Base() string
  • func (m *Module) Canonical(url string) definition.Canonical
  • func (m *Module) CodeSystems() []*definition.CodeSystem
  • func (m *Module) ConceptMaps() []*definition.ConceptMap
  • func (m *Module) Contains(url string) bool
  • func (m *Module) FilterAll(pkg registry.PackageRef) []definition.Canonical
  • func (m *Module) FilterCodeSystems(pkg registry.PackageRef) []*definition.CodeSystem
  • func (m *Module) FilterConceptMaps(pkg registry.PackageRef) []*definition.ConceptMap
  • func (m *Module) FilterStructureDefinitions(pkg registry.PackageRef) []*definition.StructureDefinition
  • func (m *Module) FilterValueSets(pkg registry.PackageRef) []*definition.ValueSets
  • func (m *Module) FromPackage(pkg *registry.Package) error
  • func (m *Module) LookupCanonical(url string) (definition.Canonical, bool)
  • func (m *Module) LookupCodeSystem(url string) (*definition.CodeSystem, bool)
  • func (m *Module) LookupConceptMap(url string) (*definition.ConceptMap, bool)
  • func (m *Module) LookupSource(url string) (*Source, bool)
  • func (m *Module) LookupStructureDefinition(url string) (*definition.StructureDefinition, bool)
  • func (m *Module) LookupValueSet(url string) (*definition.ValueSets, bool)
  • func (m *Module) ParseFile(file string, pkg registry.PackageRef) error
  • func (m *Module) ParseJSON(data []byte, pkg registry.PackageRef) error
  • func (m *Module) ParseReader(reader io.Reader, pkg registry.PackageRef) error
  • func (m *Module) Source(url string) *Source
  • func (m *Module) SourceOf(canonical definition.Canonical) *Source
  • func (m *Module) StructureDefinitions() []*definition.StructureDefinition
  • func (m *Module) ValueSets() []*definition.ValueSets
• type Source

Types

type Module

type Module struct {
	// contains filtered or unexported fields
}

Module is the raw conformance module for the FHIR definitions.

func DefaultModule

func DefaultModule() *Module

DefaultModule returns a new conformance module with the FHIR canonical URL.

func NewModule

func NewModule(base string) *Module

NewModule constructs a new conformance module.

func (*Module) AddDefinition

func (m *Module) AddDefinition(canonical definition.Canonical, src *Source)

AddDefinition adds a new definition to the conformance module.

func (*Module) All

func (m *Module) All() []definition.Canonical

All returns all the canonical definitions in the conformance module, sorted by URL.

func (*Module) Base

func (m *Module) Base() string

Base returns the base URL of the conformance module.

func (*Module) Canonical

func (m *Module) Canonical(url string) definition.Canonical

Canonical returns the canonical definition for the given URL.

func (*Module) CodeSystems

func (m *Module) CodeSystems() []*definition.CodeSystem

CodeSystems returns all the code systems in the conformance module.

func (*Module) ConceptMaps

func (m *Module) ConceptMaps() []*definition.ConceptMap

ConceptMaps returns all the concept maps in the conformance module.

func (*Module) Contains

func (m *Module) Contains(url string) bool

Contains returns true if the conformance module contains the given URL.

func (*Module) FilterAll

func (m *Module) FilterAll(pkg registry.PackageRef) []definition.Canonical

func (*Module) FilterCodeSystems

func (m *Module) FilterCodeSystems(pkg registry.PackageRef) []*definition.CodeSystem

FilterCodeSystems returns the code systems that are from the given package.

func (*Module) FilterConceptMaps

func (m *Module) FilterConceptMaps(pkg registry.PackageRef) []*definition.ConceptMap

FilterConceptMaps returns the concept maps that are from the given package.

func (*Module) FilterStructureDefinitions

func (m *Module) FilterStructureDefinitions(pkg registry.PackageRef) []*definition.StructureDefinition

FilterStructureDefinitions returns the structure definitions that are from the given package.

func (*Module) FilterValueSets

func (m *Module) FilterValueSets(pkg registry.PackageRef) []*definition.ValueSets

FilterValueSets returns the value sets that are from the given package.

func (*Module) FromPackage

func (m *Module) FromPackage(pkg *registry.Package) error

FromPackage loads the conformance module from all the resources in the registry cache.

func (*Module) LookupCanonical

func (m *Module) LookupCanonical(url string) (definition.Canonical, bool)

LookupCanonical returns the canonical definition for the given URL.

func (*Module) LookupCodeSystem

func (m *Module) LookupCodeSystem(url string) (*definition.CodeSystem, bool)

LookupCodeSystem returns the code system for the given URL.

func (*Module) LookupConceptMap

func (m *Module) LookupConceptMap(url string) (*definition.ConceptMap, bool)

LookupConceptMap returns the concept map for the given URL.

func (*Module) LookupSource

func (m *Module) LookupSource(url string) (*Source, bool)

LookupSource returns the source information for the given URL.

func (*Module) LookupStructureDefinition

func (m *Module) LookupStructureDefinition(url string) (*definition.StructureDefinition, bool)

LookupStructureDefinition returns the structure definition for the given URL.

func (*Module) LookupValueSet

func (m *Module) LookupValueSet(url string) (*definition.ValueSets, bool)

LookupValueSet returns the value set for the given URL.

func (*Module) ParseFile

func (m *Module) ParseFile(file string, pkg registry.PackageRef) error

ParseFile parses a file and adds the definitions to the conformance module.

func (*Module) ParseJSON

func (m *Module) ParseJSON(data []byte, pkg registry.PackageRef) error

ParseJSON parses a JSON byte slice and adds the definitions to the conformance module.

func (*Module) ParseReader

func (m *Module) ParseReader(reader io.Reader, pkg registry.PackageRef) error

ParseReader parses a reader and adds the definitions to the conformance module.

func (*Module) Source

func (m *Module) Source(url string) *Source

Source returns the source information for the given URL.

func (*Module) SourceOf

func (m *Module) SourceOf(canonical definition.Canonical) *Source

SourceOf returns the source information for the specific canonical definition.

func (*Module) StructureDefinitions

func (m *Module) StructureDefinitions() []*definition.StructureDefinition

StructureDefinitions returns all the structure definitions in the conformance module.

func (*Module) ValueSets

func (m *Module) ValueSets() []*definition.ValueSets

ValueSets returns all the value sets in the conformance module.

type Source

type Source struct {
	Package registry.PackageRef
	File    string
}

Source is the source information for a FHIR definition.