snowstorm-client 0.1.0

Add your description here

snowstorm_client

SNOMED CT Terminology Server REST API

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 10.8.2
• Package version: 0.1.0
• Generator version: 7.14.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.snomed.org

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/bncszb/snowstorm-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/bncszb/snowstorm-client.git)

Then import the package:

import snowstorm_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import snowstorm_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import snowstorm_client
from snowstorm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://browser.ihtsdotools.org/snowstorm/snomed-ct
# See configuration.py for a list of all supported configuration parameters.
configuration = snowstorm_client.Configuration(
    host = "https://browser.ihtsdotools.org/snowstorm/snomed-ct"
)



# Enter a context with an instance of the API client
with snowstorm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = snowstorm_client.AdminApi(api_client)

    try:
        api_response = api_instance.get_ecl_cache_stats()
        print("The response of AdminApi->get_ecl_cache_stats:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminApi->get_ecl_cache_stats: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://browser.ihtsdotools.org/snowstorm/snomed-ct

Class	Method	HTTP request	Description
AdminApi	get_ecl_cache_stats	GET /admin/cache/ecl/stats
AdminPermissionsApi	find_all	GET /admin/permissions	Retrieve all permissions
AdminPermissionsApi	find_for_branch	GET /admin/permissions/{branch}	Retrieve all permissions on given branch
AdminPermissionsApi	find_global	GET /admin/permissions/global	Retrieve all global permissions
AdminPermissionsApi	find_user_group_permissions	GET /admin/permissions/user-group/{userGroup}	Retrieve all permissions for a provided user group
AuthoringStatsApi	get_changed_fsns	GET /{branch}/authoring-stats/changed-fully-specified-names
AuthoringStatsApi	get_inactivated_concepts	GET /{branch}/authoring-stats/inactivated-concepts
AuthoringStatsApi	get_inactivated_synonyms	GET /{branch}/authoring-stats/inactivated-synonyms
AuthoringStatsApi	get_new_concepts	GET /{branch}/authoring-stats/new-concepts
AuthoringStatsApi	get_new_descriptions	GET /{branch}/authoring-stats/new-descriptions
AuthoringStatsApi	get_new_synonyms_on_existing_concepts	GET /{branch}/authoring-stats/new-synonyms-on-existing-concepts
AuthoringStatsApi	get_per_module_counts	GET /{branch}/authoring-stats/module-counts	Get counts of various components types per module id
AuthoringStatsApi	get_reactivated_concepts	GET /{branch}/authoring-stats/reactivated-concepts
AuthoringStatsApi	get_reactivated_synonyms	GET /{branch}/authoring-stats/reactivated-synonyms
AuthoringStatsApi	get_stats	GET /{branch}/authoring-stats	Calculate statistics for unreleased/unversioned content to be used in daily build browser.
BranchingApi	get_branch_review	GET /reviews/{id}
BranchingApi	get_branch_review_concept_changes	GET /reviews/{id}/concept-changes
BranchingApi	get_merge_review	GET /merge-reviews/{id}
BranchingApi	get_merge_review_conflicting_concepts	GET /merge-reviews/{id}/details
BranchingApi	retrieve_all_branches	GET /branches	Retrieve all branches
BranchingApi	retrieve_branch	GET /branches/{branch}	Retrieve a single branch
BranchingApi	retrieve_branch_descendants	GET /branches/{branch}/children	Retrieve branch descendants
BranchingApi	retrieve_branch_metadata	GET /branches/{branch}/metadata	Retrieve a single branch metadata
BranchingApi	retrieve_merge	GET /merges/{mergeId}
ClassificationApi	find_classification	GET /{branch}/classifications/{classificationId}	Retrieve a classification on a branch
ClassificationApi	find_classifications	GET /{branch}/classifications	Retrieve classifications on a branch
ClassificationApi	get_concept_preview	GET /{branch}/classifications/{classificationId}/concept-preview/{conceptId}	Retrieve a preview of a concept with classification changes applied
ClassificationApi	get_equivalent_concepts	GET /{branch}/classifications/{classificationId}/equivalent-concepts	Retrieve equivalent concepts from a classification run on a branch
ClassificationApi	get_relationship_changes	GET /{branch}/classifications/{classificationId}/relationship-changes	Retrieve relationship changes made by a classification run on a branch
CodeSystemsApi	find_all_versions	GET /codesystems/{shortName}/versions	Retrieve versions of a code system
CodeSystemsApi	find_code_system	GET /codesystems/{shortName}	Retrieve a code system
CodeSystemsApi	get_latest_daily_build	GET /codesystems/{shortName}/daily-build/check	Check if daily build import matches today's date.
CodeSystemsApi	get_upgrade_job	GET /codesystems/upgrade/{jobId}	Retrieve an upgrade job.
CodeSystemsApi	list_code_systems	GET /codesystems	List code systems
ConceptsApi	find_browser_concept	GET /browser/{branch}/concepts/{conceptId}	Load a concept in the browser format.
ConceptsApi	find_concept	GET /{branch}/concepts/{conceptId}
ConceptsApi	find_concept_ancestor_paths	GET /browser/{branch}/concepts/ancestor-paths
ConceptsApi	find_concept_ancestors	GET /browser/{branch}/concepts/{conceptId}/ancestors
ConceptsApi	find_concept_children	GET /browser/{branch}/concepts/{conceptId}/children
ConceptsApi	find_concept_descendants	GET /{branch}/concepts/{conceptId}/descendants
ConceptsApi	find_concept_descriptions	GET /{branch}/concepts/{conceptId}/descriptions
ConceptsApi	find_concept_inbound_relationships	GET /{branch}/concepts/{conceptId}/inbound-relationships
ConceptsApi	find_concept_or_identifier_referenced_concept	GET /browser/{branch}/concepts/{componentId}/concept-or-identifier-ref-concept
ConceptsApi	find_concept_parents	GET /browser/{branch}/concepts/{conceptId}/parents
ConceptsApi	find_concept_references	GET /{branch}/concepts/{conceptId}/references	Find concepts which reference this concept in the inferred or stated form (including stated axioms).
ConceptsApi	find_concepts	GET /{branch}/concepts
ConceptsApi	get_browser_concepts	GET /browser/{branch}/concepts	Load concepts in the browser format.
ConceptsApi	get_concept_authoring_form	GET /{branch}/concepts/{conceptId}/authoring-form
ConceptsApi	get_concept_bulk_change	GET /browser/{branch}/concepts/bulk/{bulkChangeId}	Fetch the status of a bulk concept creation or update.
ConceptsApi	get_concept_normal_form	GET /{branch}/concepts/{conceptId}/normal-form
ConceptsApi	view_concept_history	GET /browser/{branch}/concepts/{conceptId}/history	View the history of a Concept.
DescriptionsApi	count_semantic_tags	GET /{branch}/descriptions/semantictags	List semantic tags of all active concepts together with a count of concepts using each.
DescriptionsApi	fetch_description	GET /{branch}/descriptions/{descriptionId}
DescriptionsApi	find_browser_descriptions	GET /browser/{branch}/descriptions	Search for concept descriptions.
DescriptionsApi	find_descriptions	GET /{branch}/descriptions
ExportApi	download_rf2_archive	GET /exports/{exportId}/archive	Download the RF2 archive from an export job.
ExportApi	get_export_job	GET /exports/{exportId}	Retrieve an export job.
IdentifiersApi	find_identifier_referenced_concept	GET /{branch}/identifiers/{alternateIdentifier}/referenced-concept
IdentifiersApi	find_identifiers	GET /{branch}/identifiers
ImportApi	get_import_job	GET /imports/{importId}	Retrieve an import job.
MRCMApi	retrieve_attribute_values	GET /mrcm/{branch}/attribute-values/{attributeId}	Retrieve valid values for the given attribute and term prefix.
MRCMApi	retrieve_concept_model_attribute_hierarchy	GET /mrcm/{branch}/concept-model-attribute-hierarchy	Retrieve all active concept model attributes in a hierarchical structure.
MRCMApi	retrieve_domain_attributes	GET /mrcm/{branch}/domain-attributes	Retrieve MRCM domain attributes applicable for the given stated parents.
MultiSearchApi	find_concepts1	GET /multisearch/concepts	Search concepts across multiple Code Systems.
MultiSearchApi	find_descriptions1	GET /multisearch/descriptions
MultiSearchApi	find_descriptions_reference_sets	GET /multisearch/descriptions/referencesets	Search descriptions across multiple Code Systems returning reference set membership bucket.
RefsetMembersApi	fetch_member	GET /{branch}/members/{uuid}
RefsetMembersApi	find_browser_reference_set_members_with_aggregations	GET /browser/{branch}/members
RefsetMembersApi	find_refset_members	GET /{branch}/members	Search for reference set members.
RefsetMembersApi	get_member_bulk_change	GET /{branch}/members/bulk/{bulkChangeId}	Fetch the status of a bulk reference set member create/update job.
RelationshipsApi	fetch_relationship	GET /{branch}/relationships/{relationshipId}
RelationshipsApi	find_relationships	GET /{branch}/relationships
UtilityFunctionsApi	parse_ecl	POST /util/ecl-string-to-model	Parse ECL and convert to a model representation.
UtilityFunctionsApi	parse_ecl_model	POST /util/ecl-model-to-string	Parse ECL model representation and convert it to ECL string.
ValidationApi	find_inactive_concepts_with_no_historical_association_by_inactivation_type	GET /{branch}/report/inactive-concepts-without-association
ValidationApi	get_semantict_tags	GET /validation-maintenance/semantic-tags
VersionApi	get_build_information	GET /version	Software build version and timestamp.
WebRouteApi	issue_redirect	GET /web-route	Issue 302 redirection based on locally configured web routing

Documentation For Models

• Annotation
• AnnotationComponent
• ApiError
• AsyncConceptChangeBatch
• AsyncRefsetMemberChangeBatch
• AuthoringStatsSummary
• Axiom
• AxiomComponent
• Branch
• BranchMergeJob
• BranchPojo
• BranchReview
• BranchReviewConceptChanges
• BranchState
• BrowserDescriptionSearchResultComponent
• BuildVersion
• Classification
• CodeSystem
• CodeSystemUpgradeJob
• CodeSystemVersion
• Coding
• CodingComponent
• Component
• ComponentComponent
• Concept
• ConceptComponent
• ConceptDescriptionsResultComponent
• ConceptHistory
• ConceptHistoryItem
• ConceptMicro
• ConceptMini
• ConceptMiniComponent
• ConceptReferencesResult
• ConceptViewComponent
• ConcreteValue
• ConcreteValueComponent
• Description
• DescriptionComponent
• DescriptionMicro
• EclString
• EquivalentConceptsResponse
• ExportConfiguration
• Expression
• ExpressionAttribute
• ExpressionGroup
• ExpressionStringPojo
• Identifier
• IdentifierComponent
• ImportJob
• InactivationTypeAndConceptIdListComponent
• InboundRelationshipsResultComponent
• InvalidContent
• InvalidContentComponent
• ItemsPageBrowserDescriptionSearchResultComponent
• ItemsPageClassification
• ItemsPageCodeSystem
• ItemsPageCodeSystemVersion
• ItemsPageConceptComponent
• ItemsPageConceptMini
• ItemsPageConceptMiniComponent
• ItemsPageDescriptionComponent
• ItemsPageEquivalentConceptsResponse
• ItemsPageIdentifierComponent
• ItemsPageObject
• ItemsPageObjectComponent
• ItemsPageReferenceSetMemberComponent
• ItemsPageRelationshipChange
• ItemsPageRelationshipComponent
• MergeReview
• MergeReviewConceptVersions
• Metadata
• PageBrowserDescriptionSearchResultComponent
• PageableObject
• PageableObjectComponent
• PermissionRecordComponent
• RefSetMemberPageWithBucketAggregationsReferenceSetMember
• ReferenceSetMember
• ReferenceSetMemberComponent
• Relationship
• RelationshipChange
• RelationshipComponent
• SnomedComponentObject
• SnomedComponentObjectComponent
• SortObject
• TermLangPojo
• TermLangPojoComponent
• TypeReferences

Documentation For Authorization

Endpoints do not require authorization.

Author