1. Introduction
This is a Spring MVC REST documentation generated for code system and value set vocabulary REST service.
This REST service can be accessible using the url based on the environmnet : http://{hostname}:{port}/docs/phinvads-api-guide.html
|
VADS Rest Api
This VADS REST Service migrated the existing CodeSystem and ValueSet vocabulary RESTful services.
It provids the expected functionality of codeSystem and ValueSet vocabulary based on the HL7 FHIR v3 standard.
|
2. Resource API
Collection of CRUD API endpoints used to manipulate vocabs registered.
2.1. Accessing Get Code System By Id/name
Obtains a specific code system registered in VADS by its code system id (name) or by its OID.
2.1.1. HTTP Request
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/CodeSystemController/getCodeSystemForId/http-request.adoc[]
2.1.2. HTTP Response
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/CodeSystemController/getCodeSystemForId/http-response.adoc[]
2.1.3. Response Fields
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/CodeSystemController/getCodeSystemForId/Response-fields.adoc[]
2.1.4. CURL sample
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/CodeSystemController/getCodeSystemForId/curl-request.adoc[]
2.2. Accessing Get Code System Summary
Obtain the summery of all code system.
2.2.1. HTTP Request
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/CodeSystemSummeryController/CodeSystemSummary/http-request.adoc[]
2.2.2. HTTP Response
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/CodeSystemSummeryController/CodeSystemSummary/http-response.adoc[]
2.2.3. Response Field
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/CodeSystemSummeryController/CodeSystemSummary/response-fields.adoc[]
2.2.4. CURL Request
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/CodeSystemSummeryController/CodeSystemSummary/curl-request.adoc[]
2.3. Accessing Get Value Set
Obtain the value set by OId or name.
2.3.1. HTTP Request
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/ValueSetController/getValueSetForId/http-request.adoc[]
2.3.2. HTTP Response
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/ValueSetController/getValueSetForId/http-response.adoc[]
2.3.3. Response Field
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/ValueSetController/getValueSetForId/response-fields.adoc[]
2.3.4. CURL Request
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/ValueSetController/getValueSetForId/curl-request.adoc[]
2.4. Accessing Get Value Set Summary
Obtain the value set Summary by OId or name.
2.4.1. HTTP Request
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/ValueSetSummaryController/getValueSetSummary/http-request.adoc[]
2.4.2. HTTP Response
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/ValueSetSummaryController/getValueSetSummary/http-response.adoc[]
2.4.3. Response Field
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/ValueSetSummaryController/getValueSetSummary/response-fields.adoc[]
2.4.4. CURL Request
Unresolved directive in phinvads-api-guide.adoc - include::D:\MyProjects\Java\Workspaces\MyEclipse 2021\phinvads-4.0.6.5\rest2\target/generated-snippets/ValueSetSummaryController/getValueSetSummary/curl-request.adoc[]