Formal Specification (WSDL): http://openehr.org/ckm/services/ArchetypeFinderBean?wsdl
Examples using access directly via HTML:
String[] | getDescriptionForArchetype(String archetypeId, String language, String[] descriptionTerms) |
String[] | getDescriptionForArchetypes(String[] archetypeIds, String language, String[] descriptionTerms) |
String[] | getDescriptionForAllArchetypes(String language, String[] descriptionTerms) |
String[] | getArchetypeIdsSimple(String searchParamName, String searchParamValue) |
String[] | getArchetypeIds(String[] searchParams) |
String[] | getArchetypeIdsFromPartialId(String archetypeIdPart) |
String[] | getArchetypeIdsFromPartialIdWithPositioning(String archetypeIdPart, int cursor, int size) |
String[] | getAllArchetypeIds() |
String[] | getAllArchetypeIdsWithPositioning(int cursor, int size) |
String | getArchetypeADLURL(String archetypeId) | getArchetypeXMLURL(String archetypeId) |
String[] | getArchetypeADLURLs(String[] archetypeIds) | getArchetypeXMLURLs(String[] archetypeIds) |
String | getArchetypeInADL(String archetypeId) | getArchetypeInXML(String archetypeId) |
String[] | getArchetypesInADL(String[] archetypeIds) | getArchetypesInXML(String[] archetypeIds) |
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) |
String | getParentArchetypeId(String archetypeId) |
public String[] getDescriptionForArchetypes(String[] archetypeIds, String language, String[] descriptionTerms)
Description: Retrieves the desired elements of the Description of a selection of Archetypes.
Parameters:
Returns: String[] An array of archetypeId=propertyName:propertyValue entries, e.g. for
archetypeIds =[openEHR-EHR-OBSERVATION.blood_gases.v1, openEHR-DEMOGRAPHIC-ADDRESS.address_iso.v1],
language=en,
descriptionTerms=[archetypeConcept, archetypePurpose]
the following Array of size 4 would be returned.
[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
public String[] getDescriptionForArchetype(String archetypeId, String language, String[] descriptionTerms)
Description: Retrieves the desired elements of the Description of the Archetype.
Parameters:
Returns: String[] An array of propertyName:propertyValue entries, e.g. archetypeConcept:Blood pressure measurement
public String[] getDescriptionForAllArchetypes(String language, String[] descriptionTerms)
Description: Retrieves the desired elements of the Description of a selection of Archetypes.
Parameters:
Returns: See getDescriptionForArchetypes
public String[] getArchetypeIdsSimple(String searchParamName, String searchParamValue)
Description: Searches for archetype ids based on a param name and value.
Parameters:
Returns: String[] An array of retrieved archetype ids.
public String[] getArchetypeIds(String[] searchParams)
Description: Retrieves the archetype-ids that fit the search query in searchParams. This method is there for compatibility reasons only with the ArchetypeEditor. However, it is not fully implemented, i.e.
NB: This used to be the most flexible method, exposing most of the functionality of the ArchetypeFinder in one method. However, the parameters were based flexibly on the OWL Ontology - if the properties in the ontology change, the searchParams-query may need to be adapted. CKM uses a different model.
Parameters:
Returns: String[] An array of retrieved archetype ids.
public String[] getArchetypeIdsFromPartialId(String archetypeIdPart)
Description: Searches for Archetype Ids based on a part of that Id (sorted by archetype id in ascending order)
Parameters:
Returns: String[] A String[] of Archetype-Ids that fit with the archetypeIdPart.
public String[] getArchetypeIdsFromPartialId(String archetypeIdPart, int cursor, int size)
Description: 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)
Parameters:
Returns: String[] A String[] of Archetype-Ids that fit with the archetypeIdPart. If no (more) results this array is empty.
public String[] getAllArchetypeIds()
Description: Searches for all Archetype Ids that are active and on the trunk (sorted by archetype id in ascending order)
Parameters:
Returns: String[] A String[] of Archetype-Ids
public String[] getAllArchetypeIds(int cursor, int size)
Description: Searches for all Archetype Ids that are active and on the trunk taking into account a cursor position and max number of results (sorted by archetype id in ascending order)
Parameters:
Returns: String[] A String[] of Archetype-Ids
public String getArchetypeInADL(String archetypeId)
Description: Retrieves the archetype in ADL-Form and gives it back as a String
Parameters:
Returns: String the Archetype in ADL-Form
public String[] getArchetypesInADL(String[] archetypeIds)
Description: Retrieves the archetypes in ADL-Form and gives them back as a String-array
Parameters:
Returns: String the Archetype in ADL-Form
public String[] getArchetypeADLURLs(String[] archetypeIds)
Description: Retrieves the URLs to the ADL representation of the Archetype
Parameters:
Returns: String the URL to the ADL representation of the archetype
public String getArchetypeADLURL(String archetypeId)
Description: Retrieves the URL to the ADL representation of the Archetypes
Parameters:
Returns: String the URL to the ADL representation of the archetype
public String getArchetypeMindmap(String archetypeId, String language, String locale)
Description: Retrieves the archetype in a freemind mindmap format as a String
Parameters:
Returns: String the URL to the ADL representation of the archetype
public String getParentArchetypeId(String archetypeId)
Description: Retrieves the archetype id of the parent of this archetype if any.
Parameters:
Returns: String the archetype id of the parent archetype if any