Versions Compared

Old Version 31

changes.mady.by.user Sebastian Garde

Saved on

compared with

New Version Current

changes.mady.by.user Sebastian Garde

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The SOAP-based CKM webservices described on this page are

...

no longer in use and only kept here for historical reasons.

As of CKM Release 1.10.0 (July 2018), please use the new CKM REST API described at https://ckm.openehr.org/ckm/rest-doc/ (or the respective URL for other CKM instances)

...

---

...

.


...

Usage

Formal Specification (WSDL): http://openehr.org/ckm/services/ArchetypeFinderBean?wsdl

...

Overview of Webservices

String[]

getDescriptionForArchetype(String archetypeId, String language, String[] descriptionTerms)
          Retrieves the desired elements of the Description of the archetype.

String[]

getDescriptionForArchetypes(String[] archetypeIds, String language, String[] descriptionTerms)
          Retrieves the desired elements of the Description of a selection of Archetypes.

String[]

getDescriptionForAllArchetypes(String language, String[] descriptionTerms)
          Retrieves the desired elements of the Description for all active archetypes.

String[]

getArchetypeIdsSimple(String searchParamName, String searchParamValue)
          Retrieves the archetype-ids that fit the search query.

String[]
DEPRECATED

getArchetypeIds(String[] searchParams)
          Retrieves the archetype-ids that fit the search query in searchParams This is the most flexible method, exposing most of the functionality of the Archetype Finder in one method.

String[]

getArchetypeIdsFromPartialId(String archetypeIdPart)
          Searches for Archetype Ids based on a part of that Id (sorted by archetype id in ascending order).

String[]

getArchetypeIdsFromPartialIdWithPositioning(String archetypeIdPart, int cursor, int size)
          Searches for Archetype Ids based on a part of that Id taking into account a cursor position and max number of results (sorted by archetype id in ascending order).

String[]

getAllArchetypeIds()
Gets all active trunk archetypes sorted by archetype id in ascending order.

String[]

getAllArchetypeIdsWithPositioning(int cursor, int size)
Gets all active trunk archetypes taking into account a cursor position and max number of results (sorted by archetype id in ascending order).

String

getArchetypeADLURL(String archetypeId) | getArchetypeXMLURL(String archetypeId)
         Retrieves the URL to the ADL|XML representation of the Archetype.

String[]

getArchetypeADLURLs(String[] archetypeIds) | getArchetypeXMLURLs(String[] archetypeIds)
         Retrieves the URLs to the ADL|XML representation of the Archetypes.

String

getArchetypeInADL(String archetypeId) | getArchetypeInXML(String archetypeId)
          Retrieves the archetype in ADL-Form|XML-Form and gives it back as a String.

String[]

getArchetypesInADL(String[] archetypeIds) | getArchetypesInXML(String[] archetypeIds)
          Retrieves the archetypes in ADL-Form|XML-Form and gives them back as a String-array.

String

getArchetypeInADLFromCiteableId(String cidArchetype, Integer assetVersion) | getArchetypeInXMLFromCiteableId(String cidArchetype, Integer assetVersion)

         Retrieves an archetype in ADL|XML from its citeable identifier and asset version. You can see the citeable identifier of an archetype for example in the direct URL provided on the "Share with Colleague" tab of each archetype (when signed in - e.g. 1013.1.130)

String

getArchetypeMindmap(String archetypeId, String language, String locale)
          Retrieves the archetype in a freemind mindmap format as a String .

String

getParentArchetypeId(String archetypeId)
          Retrieves the archetype id of the parent of this archetype if any.



Webservice Details

...

getDescriptionForArchetypes

public String[] getDescriptionForArchetypes(String[] archetypeIds, String language, String[] descriptionTerms)

...

[0]=openEHR-EHR-OBSERVATION.blood_gases.v1=archetypeConcept:Blood gas assessment
[1]=openEHR-EHR-OBSERVATION.blood_gases.v1=archetypePurpose:For recording the arterial or venous blood gases and respiration products.
[2]openEHR-DEMOGRAPHIC-ADDRESS.address_iso.v1=archetypeConcept:Address
[3]openEHR-DEMOGRAPHIC-ADDRESS.address_iso.v1=archetypePurpose:Representation of data about a personal/organizational address

...

getDescriptionForArchetype

public String[] getDescriptionForArchetype(String archetypeId, String language, String[] descriptionTerms)

...

Returns: String[] An array of propertyName:propertyValue entries, e.g. archetypeConcept:Blood pressure measurement

...

getDescriptionForAllArchetypes

public String[] getDescriptionForAllArchetypes(String language, String[] descriptionTerms)

...

Returns: See getDescriptionForArchetypes

...

getArchetypeIdsSimple

public String[] getArchetypeIdsSimple(String searchParamName, String searchParamValue)

...

Returns: String[] An array of retrieved archetype ids.

...

getArchetypeIds (DEPRECATED)

public String[] getArchetypeIds(String[] searchParams)

...

Returns: String[] An array of retrieved archetype ids.

...

getArchetypeIdsFromPartialId

public String[] getArchetypeIdsFromPartialId(String archetypeIdPart)

...

Returns: String[] A String[] of Archetype-Ids that fit with the archetypeIdPart.

getArchetypeIdsFromPartialIdWithPositioning

public String[] getArchetypeIdsFromPartialId(String archetypeIdPart, int cursor, int size)

...

Returns: String[] A String[] of Archetype-Ids that fit with the archetypeIdPart. If no (more) results this array is empty.

getAllArchetypeIds

public String[] getAllArchetypeIds()

...

Returns: String[] A String[] of Archetype-Ids

getAllArchetypeIdsWithPositioning

public String[] getAllArchetypeIds(int cursor, int size)

...

Returns: String[] A String[] of Archetype-Ids

...

getArchetypeInADL

public String getArchetypeInADL(String archetypeId)

...

Returns: String the Archetype in ADL-Form

...

getArchetypesInADL

public String[] getArchetypesInADL(String[] archetypeIds)
Description: Retrieves the archetypes in ADL-Form and gives them back as a String-array

...

Returns: String the Archetype in ADL-Form

...

getArchetypeADLURLs

public String[] getArchetypeADLURLs(String[] archetypeIds)

...

Returns: String the URL to the ADL representation of the archetype

...

getArchetypeADLURL

public String getArchetypeADLURL(String archetypeId)

...

Returns: String the URL to the ADL representation of the archetype

...

getArchetypeMindmap 

public String getArchetypeMindmap(String archetypeId, String language, String locale)

...

Returns: String the URL to the ADL representation of the archetype

...

getParentArchetypeId 

public String getParentArchetypeId(String archetypeId)

...