Package org.ehrbase.rest.openehr

Class OpenehrTemplateController

java.lang.Object

org.ehrbase.rest.BaseController

org.ehrbase.rest.openehr.OpenehrTemplateController

All Implemented Interfaces:

TemplateApiSpecification

@ConditionalOnMissingBean(name="primaryopenehrtemplatecontroller")
@RestController
@RequestMapping(path="${openehr-api.context-path:/rest/openehr}/v1/definition/template")
public class OpenehrTemplateController
extends BaseController
implements TemplateApiSpecification

Controller for /template resource as part of the Definitions sub-API of the openEHR REST API

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ADL_1_4

Fields inherited from class org.ehrbase.rest.BaseController

ACCEPT, ADMIN_API_CONTEXT_PATH, API_CONTEXT_PATH, API_CONTEXT_PATH_WITH_VERSION, apiContextPathWithVersion, COMPOSITION, CONTENT_TYPE, CONTRIBUTION, DEFINITION, DIRECTORY, EHR, EHR_STATUS, ETAG, IF_MATCH, LAST_MODIFIED, LOCATION, OPENEHR_AUDIT_DETAILS, OPENEHR_VERSION, PREFER, QUERY, REQ_ACCEPT, REQ_CONTENT_TYPE, RESP_CONTENT_TYPE_DESC, RETURN_MINIMAL, RETURN_REPRESENTATION, TEMPLATE, VERSIONED_COMPOSITION, VERSIONED_EHR_STATUS

Constructor Summary

Constructors

Constructor	Description
OpenehrTemplateController(TemplateService templateService, CompositionService compositionService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<String>	createTemplateClassic(String openehrVersion, String openehrAuditDetails, String prefer, String template)
org.springframework.http.ResponseEntity<org.ehrbase.openehr.sdk.response.dto.TemplateResponseData>	createTemplateNew(String openehrVersion, String openehrAuditDetails, String contentType, String accept, String prefer, String version, String template)
org.springframework.http.ResponseEntity<Object>	getTemplateClassic(String openehrVersion, String openehrAuditDetails, String accept, String templateId)
org.springframework.http.ResponseEntity<String>	getTemplateExample(String accept, String templateId, String format)
org.springframework.http.ResponseEntity<org.ehrbase.openehr.sdk.response.dto.TemplateResponseData>	getTemplateNew(String openehrVersion, String openehrAuditDetails, String accept, String templateId, String versionPattern)
org.springframework.http.ResponseEntity<List<org.ehrbase.openehr.sdk.response.dto.ehrscape.TemplateMetaDataDto>>	getTemplatesClassic(String openehrVersion, String openehrAuditDetails, String accept)
org.springframework.http.ResponseEntity<org.ehrbase.openehr.sdk.response.dto.TemplateResponseData>	getTemplatesNew(String openehrVersion, String openehrAuditDetails, String accept)
org.springframework.http.ResponseEntity<org.ehrbase.openehr.sdk.webtemplate.model.WebTemplate>	getWebTemplate(String accept, String templateId)

Methods inherited from class org.ehrbase.rest.BaseController

createLocationUri, decodeVersionAtTime, extractCompositionRepresentation, extractVersionedObjectUidFromVersionUid, extractVersionFromVersionUid, getCompositionVersionedObjectUidString, getContextPath, getContributionVersionedObjectUidString, getEhrUuid, parseUUID, resolveContentType, resolveContentType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ADL_1_4

protected static final String ADL_1_4

See Also:

• Constant Field Values

Constructor Details

OpenehrTemplateController

@Autowired
public OpenehrTemplateController(TemplateService templateService,
 CompositionService compositionService)

Method Details

createTemplateClassic

@PostMapping(path="/adl1.4",
             consumes="application/xml",
             produces="application/xml")
@ResponseStatus(CREATED)
public org.springframework.http.ResponseEntity<String> createTemplateClassic(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @RequestHeader(value="Prefer",required=false)
 String prefer,
 @RequestBody
 String template)

Specified by:

createTemplateClassic in interface TemplateApiSpecification

getTemplatesClassic

@GetMapping(value="/adl1.4",
            produces={"application/json","application/xml"})
public org.springframework.http.ResponseEntity<List<org.ehrbase.openehr.sdk.response.dto.ehrscape.TemplateMetaDataDto>> getTemplatesClassic(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @RequestHeader(value="Accept",required=false)
 String accept)

Specified by:

getTemplatesClassic in interface TemplateApiSpecification

getTemplateClassic

@GetMapping(value="/adl1.4/{template_id}",
            produces={"application/xml","application/json","application/openehr.wt+json"})
public org.springframework.http.ResponseEntity<Object> getTemplateClassic(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @RequestHeader(value="Accept",required=false)
 String accept,
 @PathVariable("template_id")
 String templateId)

Specified by:

getTemplateClassic in interface TemplateApiSpecification

getTemplateExample

@GetMapping(path="/adl1.4/{template_id}/example",
            produces={"application/json","application/xml","application/openehr.wt.structured.schema+json","application/openehr.wt.flat.schema+json"})
public org.springframework.http.ResponseEntity<String> getTemplateExample(@RequestHeader(value="Accept",required=false)
 String accept,
 @PathVariable("template_id")
 String templateId,
 @RequestParam(value="format",required=false)
 String format)

Specified by:

getTemplateExample in interface TemplateApiSpecification

getWebTemplate

@GetMapping(path="/adl1.4/{template_id}/webtemplate",
            produces={"application/json","application/openehr.wt+json"})
public org.springframework.http.ResponseEntity<org.ehrbase.openehr.sdk.webtemplate.model.WebTemplate> getWebTemplate(@RequestHeader(value="Accept",required=false)
 String accept,
 @PathVariable("template_id")
 String templateId)

Specified by:

getWebTemplate in interface TemplateApiSpecification

createTemplateNew

@PostMapping(value="/adl2",
             consumes="text/plain",
             produces="text/plain")
@ResponseStatus(CREATED)
public org.springframework.http.ResponseEntity<org.ehrbase.openehr.sdk.response.dto.TemplateResponseData> createTemplateNew(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @RequestHeader(value="Content-Type",required=false)
 String contentType,
 @RequestHeader(value="Accept",required=false)
 String accept,
 @RequestHeader(value="Prefer",required=false)
 String prefer,
 @RequestParam(value="version",required=false)
 String version,
 @RequestBody
 String template)

Specified by:

createTemplateNew in interface TemplateApiSpecification

getTemplatesNew

@GetMapping(value="/adl2",
            produces="application/json")
public org.springframework.http.ResponseEntity<org.ehrbase.openehr.sdk.response.dto.TemplateResponseData> getTemplatesNew(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @RequestHeader(value="Accept",required=false)
 String accept)

Specified by:

getTemplatesNew in interface TemplateApiSpecification

getTemplateNew

@GetMapping(value="/adl2/{template_id}/{version_pattern}",
            produces="text/plain")
public org.springframework.http.ResponseEntity<org.ehrbase.openehr.sdk.response.dto.TemplateResponseData> getTemplateNew(@RequestHeader(value="openEHR-VERSION",required=false)
 String openehrVersion,
 @RequestHeader(value="openEHR-AUDIT_DETAILS",required=false)
 String openehrAuditDetails,
 @RequestHeader(value="Accept",required=false)
 String accept,
 @PathVariable(value="template_id",required=false)
 String templateId,
 @PathVariable(value="version_pattern",required=false)
 String versionPattern)

Specified by:

getTemplateNew in interface TemplateApiSpecification