cardea.fhir.CapabilityStatement

class cardea.fhir.CapabilityStatement(dict_values=None)

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Parameters

  • resourceType – This is a CapabilityStatement resource

  • url – An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).

  • version – The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

  • name – A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.

  • title – A short, descriptive, user-friendly title for the capability statement.

  • status – The status of this capability statement. Enables tracking the life-cycle of the content.

  • experimental – A boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

  • date – The date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.

  • publisher – The name of the individual or organization that published the capability statement.

  • contact – Contact details to assist a user in finding and communicating with the publisher.

  • description – A free text natural language description of the capability statement from a consumer’s perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.

  • useContext – The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.

  • jurisdiction – A legal or geographic region in which the capability statement is intended to be used.

  • purpose – Explaination of why this capability statement is needed and why it has been designed as it has.

  • copyright – A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.

  • kind – The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).

  • instantiates – Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.

  • software – Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.

  • implementation – Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.

  • fhirVersion – The version of the FHIR specification on which this capability statement is based.

  • acceptUnknown – A code that indicates whether the application accepts unknown elements or extensions when reading resources.

  • format – A list of the formats supported by this implementation using their content types.

  • patchFormat – A list of the patch formats supported by this implementation using their content types.

  • implementationGuide – A list of implementation guides that the server does (or should) support in their entirety.

  • profile – A list of profiles that represent different use cases supported by the system. For a server, “supported by the system” means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).

  • rest – A definition of the restful capabilities of the solution, if any.

  • messaging – A description of the messaging capabilities of the solution.

  • document – A document definition.

__init__(dict_values=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([dict_values])

Initialize self.

assert_type()

Checks class values follow set possible enumerations.

get_dataframe()

Returns dataframe from class attribute values.

get_eligible_relationships()

Returns class relationships for attributes that are used.

get_id()

Returns fhir class identifier.

get_relationships()

Returns class relationships.

set_attributes(dict_values)

Sets values to class attributes.
cardea.fhir.Bundle cardea.fhir.CarePlan