Identifier Domain Resource

Owned by Wentong Ling (Unlicensed)
Last updated: Feb 25, 2019 by Sophia
2 min read

Identifier Domain Resource


URL: /openempi-ws-rest/1.0/identifier-domains

Methods

GET

Returns the complete list of identifier domains that have been defined in the system.

Responses

  • 200 - application/json - Returns a JSON representation of the response based on the Accept header

  • 200 - application/xml - Returns an XML representation of the response based on the Accept header

  • 404 - Returned if there are no entities defined in the system

Example

Version 1.0

http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/identifier-domains

Return:

<identifierDomains>

    <identifierDomain>

        <dateCreated>2013-01-17T11:33:45.903-05:00</dateCreated>

        <identifierDomainDescription>IHERED</identifierDomainDescription>

        <identifierDomainId>2750</identifierDomainId>

        <identifierDomainName>IHERED</identifierDomainName>

        <namespaceIdentifier>IHERED</namespaceIdentifier>

        <universalIdentifier>1.3.6.1.4.1.21367.13.20.1000</universalIdentifier>

        <universalIdentifierTypeCode>ISO</universalIdentifierTypeCode>

    </identifierDomain>

    <identifierDomain>

        <dateCreated>2012-02-10T13:44:24.755-05:00</dateCreated>

        <identifierDomainDescription>OpenEMPI Domain</identifierDomainDescription>

        <identifierDomainId>56</identifierDomainId>

        <identifierDomainName>2.16.840.1.113883.4.357</identifierDomainName>

        <namespaceIdentifier>2.16.840.1.113883.4.357</namespaceIdentifier>

        <universalIdentifier>2.16.840.1.113883.4.357</universalIdentifier>

        <universalIdentifierTypeCode>hl7</universalIdentifierTypeCode>

    </identifierDomain>

</identifierDomains>

 

URL: /openempi-ws-rest/1.0/identifier-domains/{identifierDomainId}

 Parameters

Parameter

Value Type

Parameter Type

R/O

Description

identifierDomainId

Integer

Path Parameter

R

The unique identifier of the identifier domain of interest

Methods

GET

Returns detailed information about the identifier domain identified by the parameter identifierDomainId

Responses

  • 200 - application/json - Returns a JSON representation of the response based on the Accept header

  • 200 - application/xml - Returns an XML representation of the response based on the Accept header

  • 404 - Returned if there is no entity known in the system with that entityId

Example

Version 1.0

Identifier domain id is 2750.

http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/identifier-domains/2750

Return:

<identifierDomain>

    <dateCreated>2013-01-17T11:33:45.903-05:00</dateCreated>

    <identifierDomainDescription>IHERED</identifierDomainDescription>

    <identifierDomainId>2750</identifierDomainId>

    <identifierDomainName>IHERED</identifierDomainName>

    <namespaceIdentifier>IHERED</namespaceIdentifier>

    <universalIdentifier>1.3.6.1.4.1.21367.13.20.1000</universalIdentifier>

    <universalIdentifierTypeCode>ISO</universalIdentifierTypeCode>

</identifierDomain>

 

URL(POST for add): /openempi-ws-rest/1.0/identifier-domains

Parameters

Parameter

Value Type

Parameter Type

R/O

Description

identifierDomainIdentifierDomainBodyRAn IdentifierDomain object

Methods

POST

Returns the newly added IdentifierDomain.

Responses

  • 200 - application/json - Returns a JSON representation of the response based on the Accept header

  • 200 - application/xml - Returns an XML representation of the response based on the Accept header

  • 400 - Returned if there is a bad request.

  • 409 - Returned if there is a record conflict in the system.

Example

Version 1.0

POST

http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/identifier-domains

Content-Type: application/xml

Body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<identifierDomain>
    <dateCreated>2013-10-01</dateCreated>
    <identifierDomainDescription>Test</identifierDomainDescription>
    <identifierDomainName>Test-Domaon</identifierDomainName>
    <namespaceIdentifier>Test-Domaon</namespaceIdentifier>
    <universalIdentifier></universalIdentifier>
    <universalIdentifierTypeCode></universalIdentifierTypeCode>
</identifierDomain>>

Return:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<identifierDomain>
    <dateCreated>2013-10-08T13:21:26.091-04:00</dateCreated>
    <identifierDomainDescription>Test</identifierDomainDescription>
    <identifierDomainId>139</identifierDomainId>
    <identifierDomainName>Test-Domaon</identifierDomainName>
    <namespaceIdentifier>Test-Domaon</namespaceIdentifier>
    <universalIdentifier></universalIdentifier>
    <universalIdentifierTypeCode></universalIdentifierTypeCode>
</identifierDomain>

 

Content-Type: application/json

Body:

{ "dateCreated" : "2013-10-08",
  "identifierDomainDescription" : "Test",
  "identifierDomainName" : "Test-Domaon",
  "namespaceIdentifier" : "Test-Domaon",
  "universalIdentifier" : "",
  "universalIdentifierTypeCode" : ""
}

Return:

{ "dateCreated" : "2013-10-08T13:17:21.881-04:00",
  "identifierDomainDescription" : "Test",
  "identifierDomainId" : "139",
  "identifierDomainName" : "Test-Domaon",
  "namespaceIdentifier" : "Test-Domaon",
  "universalIdentifier" : "",
  "universalIdentifierTypeCode" : ""
}

 

URL(PUT for update): /openempi-ws-rest/1.0/identifier-domains

Parameters

Parameter

Value Type

Parameter Type

R/O

Description

identifierDomainIdentifierDomainBodyRAn IdentifierDomain object

Methods

PUT

Returns the updated IdentifierDomain.

Responses

  • 200 - application/json - Returns a JSON representation of the response based on the Accept header

  • 200 - application/xml - Returns an XML representation of the response based on the Accept header

  • 400 - Returned if there is a bad request.

  • 409 - Returned if there is a record conflict in the system.

Example

Version 1.0

PUT

http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/identifier-domains

Content-Type: application/xml

Body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<identifierDomain>
    <dateCreated>2013-10-08T13:21:26.091-04:00</dateCreated>
    <identifierDomainDescription>Update</identifierDomainDescription>
    <identifierDomainId>139</identifierDomainId>
    <identifierDomainName>Update-Domaon</identifierDomainName>
    <namespaceIdentifier>Update-Domaon</namespaceIdentifier>
    <universalIdentifier></universalIdentifier>
    <universalIdentifierTypeCode></universalIdentifierTypeCode>
</identifierDomain>

Return:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<identifierDomain>
    <dateCreated>2013-10-08T13:24:57.230-04:00</dateCreated>
    <identifierDomainDescription>Update</identifierDomainDescription>
    <identifierDomainId>139</identifierDomainId>
    <identifierDomainName>Update-Domaon</identifierDomainName>
    <namespaceIdentifier>Update-Domaon</namespaceIdentifier>
    <universalIdentifier></universalIdentifier>
    <universalIdentifierTypeCode></universalIdentifierTypeCode>
</identifierDomain>

 

Content-Type: application/json

Body:

{ "dateCreated" : "2013-10-08T13:17:21.881-04:00",
  "identifierDomainDescription" : "Update",
  "identifierDomainId" : "139",
  "identifierDomainName" : "Update-Domaon",
  "namespaceIdentifier" : "Update-Domaon",
  "universalIdentifier" : "",
  "universalIdentifierTypeCode" : ""
}

Return:

{ "dateCreated" : "2013-10-08T13:57:21.881-04:00",
  "identifierDomainDescription" : "Update",
  "identifierDomainId" : "139",
  "identifierDomainName" : "Update-Domaon",
  "namespaceIdentifier" : "Update-Domaon",
  "universalIdentifier" : "",
  "universalIdentifierTypeCode" : ""
}