fhir

Documentation

Index

• type Bundle
  • func ReadBundle(r io.Reader) (Bundle, error)
  • func UnmarshalBundle(b []byte) (Bundle, error)
  • func (b Bundle) MarshalJSON() ([]byte, error)
• type BundleEntry
• type BundleEntryRequest
• type BundleEntryResponse
• type CapabilityStatement
  • func ReadCapabilityStatement(r io.Reader) (CapabilityStatement, error)
• type CapabilityStatementRest
• type CapabilityStatementRestResource
  • func (r CapabilityStatementRestResource) DoesSupportsInteraction(code string) bool
• type CapabilityStatementRestResourceInteraction
• type Client
  • func (c *Client) CloseIdleConnections()
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) NewBatchRequest(body io.Reader) (*http.Request, error)
  • func (c *Client) NewCapabilitiesRequest() (*http.Request, error)
  • func (c *Client) NewSearchTypeRequest(resourceType string) (*http.Request, error)
  • func (c *Client) NewTransactionRequest(body io.Reader) (*http.Request, error)
  • func (c *Client) SearchTypeURL(resourceType string) string

Types

type Bundle

type Bundle struct {
	Type  string
	Total *int
	Entry []BundleEntry
}

Bundle is documented here https://www.hl7.org/fhir/bundle.html

func ReadBundle

func ReadBundle(r io.Reader) (Bundle, error)

ReadBundle reads and unmarshals a bundle.

func UnmarshalBundle

func UnmarshalBundle(b []byte) (Bundle, error)

UnmarshalBundle unmarshals a bundle.

func (Bundle) MarshalJSON

func (b Bundle) MarshalJSON() ([]byte, error)

MarshalJSON marshals the given bundle as JSON into a byte slice

type BundleEntry

type BundleEntry struct {
	Resource json.RawMessage      `json:"resource,omitempty"`
	Request  *BundleEntryRequest  `json:"request,omitempty"`
	Response *BundleEntryResponse `json:"response,omitempty"`
}

BundleEntry represents the Bundle.entry BackboneElement

type BundleEntryRequest

type BundleEntryRequest struct {
	Method string `json:"method"`
	URL    string `json:"url"`
}

BundleEntryRequest represents the Bundle.entry.request BackboneElement

type BundleEntryResponse

type BundleEntryResponse struct {
	Status string `json:"status"`
}

BundleEntryResponse represents the Bundle.entry.response BackboneElement

type CapabilityStatement

type CapabilityStatement struct {
	FhirVersion string
	Rest        []CapabilityStatementRest
}

CapabilityStatement is documented here https://www.hl7.org/fhir/capabilitystatement.html

func ReadCapabilityStatement

func ReadCapabilityStatement(r io.Reader) (CapabilityStatement, error)

ReadCapabilityStatement reads and unmarshals a capability statement.

type CapabilityStatementRest

type CapabilityStatementRest struct {
	Mode     string
	Resource []CapabilityStatementRestResource
}

CapabilityStatementRest represents the CapabilityStatement.rest BackboneElement

type CapabilityStatementRestResource

type CapabilityStatementRestResource struct {
	Type        string
	Interaction []CapabilityStatementRestResourceInteraction
}

CapabilityStatementRestResource represents the CapabilityStatement.rest.resource BackboneElement

func (CapabilityStatementRestResource) DoesSupportsInteraction

func (r CapabilityStatementRestResource) DoesSupportsInteraction(code string) bool

DoesSupportsInteraction returns true iff the resource supports the given interaction. Possible interactions are defined in https://www.hl7.org/fhir/valueset-type-restful-interaction.html

type CapabilityStatementRestResourceInteraction

type CapabilityStatementRestResourceInteraction struct {
	Code string
}

CapabilityStatementRestResourceInteraction represents the CapabilityStatement.rest.resource.interaction BackboneElement

type Client

type Client struct {
	HttpClient http.Client
	Base       string
}

A Client is a FHIR client which combines an HTTP client with the base URL of a FHIR server. At minimum, the Base has to be set. HttpClient can be left at its default value.

func (*Client) CloseIdleConnections

func (c *Client) CloseIdleConnections()

CloseIdleConnections calls CloseIdleConnections on the HTTP client of the FHIR client.

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

Do calls Do on the HTTP client of the FHIR client.

func (*Client) NewBatchRequest

func (c *Client) NewBatchRequest(body io.Reader) (*http.Request, error)

NewBatchRequest creates a new transaction/batch interaction request. Uses the base URL from the FHIR client and sets JSON Accept and Content-Type headers. Otherwise it's identical to http.NewRequest.

func (*Client) NewCapabilitiesRequest

func (c *Client) NewCapabilitiesRequest() (*http.Request, error)

NewCapabilitiesRequest creates a new capabilities interaction request. Uses the base URL from the FHIR client and sets JSON Accept header. Otherwise it's identical to http.NewRequest.

func (*Client) NewSearchTypeRequest

func (c *Client) NewSearchTypeRequest(resourceType string) (*http.Request, error)

NewSearchTypeRequest creates a new search-type interaction request. Uses the base URL from the FHIR client and sets JSON Accept header. Otherwise it's identical to http.NewRequest.

func (*Client) NewTransactionRequest

func (c *Client) NewTransactionRequest(body io.Reader) (*http.Request, error)

NewTransactionRequest creates a new transaction/batch interaction request. Uses the base URL from the FHIR client and sets JSON Accept and Content-Type headers. Otherwise it's identical to http.NewRequest.

func (*Client) SearchTypeURL

func (c *Client) SearchTypeURL(resourceType string) string

SearchTypeURL generates the URL for a search-type interaction of the given resource type