GUID or alphanumeric ID which uniquely identifies the data representing the canonical record in the underlying local system A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR. Note: A HIN is considered a local system by the IXS service The name of the Semantic Signifier (e.g., HL7V2.4PATIENT) for the type Identity you intend on Registering with the IXS A document of a type identified by the SemanticSignifierName and containing the information or Traits that describe the Identity being registered in the IXS A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR. Note: A HIN is considered a local system by the IXS service The name of the Semantic Signifier (e.g., HL7V2.4PATIENT) for the type Identity you intend on Creating in the IXS A document of a type identified by the SemanticSignifierName and containing the information or Traits that describe the Identity being Created in the IXS GUID or alphanumeric ID which uniquely identifies the data representing the canonical record in the underlying local system A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR. The name of the Semantic Signifier (e.g., HL7V2.4PATIENT) for the type Identity you intend on Updating in the IXS A document of a type identified by the SemanticSignifierName and containing the information or Traits that describe the Identity whose traits are being Updated in the IXS GUID or alphanumeric ID which uniquely identifies the data representing he canonical record in the underlying local system A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR. The name of the Semantic Signifier (e.g., HL7V2.4PATIENT) for the type Identity you intend on Removing from the IXS A document of a type identified by the SemanticSignifierName and containing the information or Traits that describe the Identity being Removed from the IXS The name of the Semantic Signifier (e.g., HL7V2.4PATIENT) for the type of Identity for the subject of the call GUID or alphanumeric ID which uniquely identifies the data representing the canonical record in the underlying local system A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR. A set of SourceIds that can limit the set of identities returned by the search The name of the Semantic Signifier (e.g., HL7V2.4PATIENT) for the type of Identity for the subject of the call GUID or alphanumeric ID which uniquely identifies the data representing the canonical record in the underlying local system A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR. A set of SourceIds that can limit the set of identities returned by the search The name of the SemanticSignifier (e.g., PERSON_PROFILE) for the type you want to return trait definitions for GUID or alphanumeric ID which uniquely identifies the data representing the canonical record in the underlying local system A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR. Note: A HIN is considered a local system by the IXS service A document of a type identified by the SemanticSignifierName and containing the information or Traits that describe the Identity retrieved from the IXS The name of the SemanticSignifier (e.g., PERSON_PROFILE) for the type of identities you want to find GUID or alphanumeric ID which uniquely identifies the data representing the canonical record in the underlying local system A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR. Note: A HIN is considered a local system by the IXS service A GUID or alphanumeric ID which uniquely identifies the identity of the Real World Entity within the IXS A document of a type identified by the SemanticSignifierName and containing the information or Traits that describe the Identity found in the IXS The name of the SemanticSignifier The name of the underlying EntityType that this SemanticSignifier represents Globally unique alphanumeric ID, represented as a GUID Example: URI to XSD in XML Example: URI to XSL in XML Example: URI to SCHEMATRON or WSDL reference in XML A boolean flag representing the success or failure of the API operation. True indicates that the operation was successful and false indicates a non-successful operation An array of the status-condition structure A 4 digit numeric code representation of the outcome of the API operation. A statusCode instance has two dimensions. First, each statusCode is unique and represents a single specific condition that may occur within the IXS. Second, statusCodes are numeric and their range will indicate a class of conditions that has occurred. For example, status-codes in the range of 1000-1999 indicate a successful operation. A more detailed description of the condition that occurred. An alpha-numeric message describing the outcome of the API operation. An enumeration that indicates the severity of the status-code returned. This function deletes a Source ID/Entity ID pair and its associated Traits from the IXS repository. Status Conditions Returned Code Severity Message 1004 Info Entity reference has been successfully removed in the IXS 2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS 2002 Error The Trait identified by ‘%1’ does not exist in the IXS 2007 Error Entity Referenced does not exist in the IXS 2008 Error Wrong existing state for deletion 2100 Error Identity linked to other identities This operation generates an Entity ID on behalf of a Source that does not generate Entity IDs. It inserts the Source ID/newly-generated Entity ID pair and supplied Traits into the IXS with implicit linking to other matching Source ID/ Entity ID pairs, based on the configured internal matching algorithm. Status Conditions Returned Code Severity Message 1001 Info An IXSEntityIdentifier was successfully created in the IXS 2001 Error The mandatory Trait ‘%1’ for the Entity Type ‘%2’ was not provided 2002 Error The Trait identified by ‘%1’ does not exist in the IXS 2003 Error The Identifying Trait list provided contains a duplicate Trait ‘%1’ 2004 Error An invalid value was passed for Trait ‘%1’ 2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS 3001 Warning The Entity referenced by the ID information provided may already exist in the IXS This operation inserts a Source ID/Entity ID pair and supplied Traits into the IXS with implicit linking to other matching Source ID/ Entity ID pairs, based on the configured internal matching algorithm. Status Conditions Returned Code Severity Message 1002 Info Entity has been successfully registered with identifier ‘%1’ in the IXS 2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS 2001 Error The mandatory Trait ‘%1’ for the Entity Type ‘%2’ was not provided 2002 Error The Trait identified by ‘%1’ does not exist in the IXS 2003 Error The Identifying Trait list provided contains a duplicate Trait ‘%1’ 2004 Error An invalid value was passed for the Trait ‘%1’ 2005 Error An entity with that ID already exists 3001 Warning The Entity referenced by the ID information provided may already exist in the IXS This operation updates the Traits stored in the IXS for the Entity identified by the supplied Source ID/Entity ID pair. Whether this entails re-analyzing matching identities is implementation specific, although it would be done in most cases. How it would be done is also implementation specific. Status Conditions Returned Code Severity Message 1003 Info Entity Trait Values have been successfully updated in the IXS 2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS 2002 Error The Trait identified by ‘%1’ does not exist in the IXS 2003 Error The Identifying Trait list provided contains 1 or more duplicates 2004 Error An invalid value was passed for the Trait ‘%1’ 2005 Error Attempt to delete 1 or more mandatory Traits for the Entity Type ‘%1’ 2006 Error 1 or more Traits passed in the list are not valid or do not exist for Entity Type ‘%1’ This operation provides the means to perform a broad search of all records in the IXS whose Traits match some criteria in the supplied search criteria (such as find all records who match the name “Jones, Bob”. Status Conditions Returned Code Severity Message 1006 Info ‘%1’ Entities successfully retrieved 2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS 2002 Error The Trait identified by ‘%1’ does not exist in the IXS 2007 Error Entity Referenced does not exist in the IXS This operation retrieves all the Source ID/Entity ID pairs that are linked to the supplied Source ID/Entity ID pair. Status Conditions Returned Code Severity Message 1007 Info ‘%1’ Linked Entities successfully retrieved 2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS 2007 Error Entity Referenced does not exist in the IXS 2002 Error The Trait identified by ‘%1’ does not exist in the IXS 2011 Error Identity Qualifier ‘%1’ does not exist in the IXS This operation retrieves duplicately specified, yet unlinked records in the IXS repository. It filters the record set to only return matching, but unlinked records. Status Conditions Returned Code Severity Message 1008 Info ‘%1’ UnLinked Entities successfully retrieved 2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS 2007 Error Entity Referenced does not exist in the IXS 2002 Error The Trait identified by ‘%1’ does not exist in the IXS 2011 Error Identity Qualifier ‘%1’ does not exist in the IXS Retrieves the Traits associated with a Source ID/Entity ID pair. Status Conditions Returned Code Severity Message 1005 Info Entity Trait values retrieved successfully 2008 Error The Entity Type identified by ‘%1’ does not exist in the IXS 3001 Error Entity Referenced does not exist in the IXS Entity Identification Service (IXS): Managment And Query Interface