> For the complete documentation index, see [llms.txt](https://help.santesuite.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.santesuite.org/developers/service-apis/health-data-service-interface-hdsi/api-documentation/models.md). # Models ## The MailMessage object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"MailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/messaging"},"properties":{"body":{"xml":{"name":"body","attribute":false},"description":"Gets or sets the alert body of the alert.","type":"string"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the status of the alert.","type":"string","enum":["None","Alert","LowPriority","HighPriority"]},"from":{"xml":{"name":"from","attribute":false},"description":"Gets or sets the \"from\" subject if it is a human based message of the alert.","type":"string","format":"uuid"},"fromInfo":{"xml":{"name":"fromInfo","attribute":false},"description":"From Information (string representation)","type":"string"},"toInfo":{"xml":{"name":"toInfo","attribute":false},"description":"To information","type":"string"},"to":{"xml":{"name":"to","attribute":false},"description":"Legacy property for the \"to\" field (so sync can occur on older tablets)","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets the time this was modified on","type":"string","format":"date"},"rcpt":{"xml":{"name":"rcpt","attribute":false},"description":"The recipient users used for query","type":"array","items":{"type":"string","format":"uuid"}},"subject":{"xml":{"name":"subject","attribute":false},"description":"Gets or sets the subject of the alert.","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an alert message.","type":"object"}}}} ``` ## The DeviceEntity object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"DeviceEntity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"manufacturerModelName":{"xml":{"name":"manufacturerModelName","attribute":false},"description":"Gets or sets the manufacturer model name","type":"string"},"operatingSystemName":{"xml":{"name":"operatingSystemName","attribute":false},"description":"Gets or sets the operating system name","type":"string"},"securityDevice":{"xml":{"name":"securityDevice","attribute":false},"description":"Gets or sets the security device key","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a device entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The Mailbox object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Mailbox":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"owner":{"xml":{"name":"owner","attribute":false},"description":"Gets or sets the user which owns this mailbox","type":"string","format":"uuid"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the mailbox","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a mailbox - a particular folder or place which holds","type":"object"}}}} ``` ## The DateObservation object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"DateObservation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the key of the uom concept","type":"string"},"valuePrecision":{"xml":{"name":"valuePrecision","attribute":false},"description":"Precision of the data in","type":"string","enum":["F","Y","m","D","H","M","S"]},"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an observation which contains a date value","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The EntityRelationship object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"}}}} ``` ## The ConceptExtension object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ConceptExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"}}}} ``` ## The Object object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Object":{"properties":{},"type":"object"}}}} ``` ## The ConceptClass object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ConceptClass":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the concept class","type":"string"},"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic","type":"string"},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Identifies a classification for a concept","type":"object"}}}} ``` ## The QuantityObservation object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"QuantityObservation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the observed quantity","type":"number","format":"double"},"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"unitOfMeasure":{"xml":{"name":"unitOfMeasure","attribute":false},"description":"Gets or sets the key of the uom concept","type":"string","format":"uuid"},"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an observation that contains a quantity","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The ActRelationship object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"}}}} ``` ## The CodedObservation object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"CodedObservation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the key of the uom concept","type":"string","format":"uuid"},"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an observation with a concept value","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The Organization object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Organization":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"industryConcept":{"xml":{"name":"industryConcept","attribute":false},"description":"Gets or sets the concept key which classifies the industry in which the organization operates","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Organization entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The SecurityEntity object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"SecurityEntity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Security Entity base class","type":"object"}}}} ``` ## The Container object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Container":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"lotNumber":{"xml":{"name":"lotNumber","attribute":false},"description":"Gets or sets the lot number of the manufactured material","type":"string"},"capacityQuantity":{"xml":{"name":"capacityQuantity","attribute":false},"description":"Gets or sets the capacity quantity. The functional capacity of the container.","type":"number","format":"double"},"diameterQuantity":{"xml":{"name":"diameterQuantity","attribute":false},"description":"Gets or sets the diameter quantity. The outside diameter of the container.","type":"number","format":"double"},"heightQuantity":{"xml":{"name":"heightQuantity","attribute":false},"description":"Gets or sets the height quantity. The height of the container.","type":"number","format":"double"},"expiryDate":{"xml":{"name":"expiryDate","attribute":false},"description":"Gets or sets the expiry date of the material","type":"string"},"formConcept":{"xml":{"name":"formConcept","attribute":false},"description":"Gets or sets the form concept's key","type":"string","format":"uuid"},"isAdministrable":{"xml":{"name":"isAdministrable","attribute":false},"description":"True if the material is simply administrative","type":"boolean"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n which is a /per ...","type":"number","format":"double"},"quantityConcept":{"xml":{"name":"quantityConcept","attribute":false},"description":"Gets or sets the quantity concept ref","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a container.","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The Patient object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The ConceptSet object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ConceptSet":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the concept set","type":"string"},"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic for the concept set (used for convenient lookup)","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the concept set","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"Gets or sets the url of the concept set","type":"string"},"concept":{"xml":{"name":"concept","attribute":false},"description":"Concepts as identifiers for XML purposes only","type":"array","items":{"type":"string","format":"uuid"}},"compose":{"xml":{"name":"compose","attribute":false},"description":"If the concept set is composed of other concept sets","type":"array","items":{"$ref":"#/components/schemas/ConceptSetComposition","type":"object"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents set of concepts","type":"object"},"ConceptSetComposition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"instruction":{"xml":{"name":"instruction","attribute":false},"description":"The composition operation","type":"string","enum":["include","exclude"]},"target":{"xml":{"name":"target","attribute":false},"description":"Gets the target of the composition","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a reference between two different concept sets","type":"object"}}}} ``` ## The MailboxMailMessage object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"}}}} ``` ## The Protocol object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Protocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the protocol","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the OID","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents the model of a clinical protocol for CDR","type":"object"}}}} ``` ## The Bundle object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Bundle":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time the bundle was modified","type":"string","format":"date"},"correlationSeq":{"xml":{"name":"correlationSeq","attribute":false},"description":"Gets or sets the sequence control for this bundle","type":"number","format":"int64"},"correlationId":{"xml":{"name":"correlationId","attribute":false},"description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string","format":"uuid"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets or sets items in the bundle","type":"array","items":{"$ref":"#/components/schemas/IdentifiedData","type":"object"}},"focal":{"xml":{"name":"focal","attribute":false},"description":"Entry into the bundle","type":"array","items":{"type":"string","format":"uuid"}},"offset":{"xml":{"name":"offset","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"count":{"xml":{"name":"count","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"totalResults":{"xml":{"name":"totalResults","attribute":false},"description":"Gets or sets the total results","type":"number","format":"int32"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A bundle represents a batch of objects which are included within the bundle","type":"object"},"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","type":"object"}}}} ``` ## The ServiceOptions object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ServiceOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"version":{"xml":{"name":"version","attribute":true},"description":"Gets or sets the version of the service interface","type":"string"},"server":{"xml":{"name":"server","attribute":true},"description":"Gets the server informational version","type":"string"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets the service resource options","type":"array","items":{"$ref":"#/components/schemas/ServiceResourceOptions","type":"object"}},"endpoint":{"xml":{"name":"endpoint","attribute":false},"description":"Gets or sets the endpoint options","type":"array","items":{"$ref":"#/components/schemas/ServiceEndpointOptions","type":"object"}},"settings":{"xml":{"name":"settings","attribute":false},"description":"Gets or sets the flags on the service","type":"array","items":{"$ref":"#/components/schemas/AppSettingKeyValuePair","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets the modified on date time of the service options.","type":"string","format":"date"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Service options","type":"object"},"ServiceResourceOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"resource":{"xml":{"name":"resource","attribute":true},"description":"Gets the name of the resource","type":"string"},"cap":{"xml":{"name":"cap","attribute":false},"description":"Gets or sets the operations supported by this resource","type":"array","items":{"$ref":"#/components/schemas/ServiceResourceCapability","type":"object"}},"children":{"xml":{"name":"children","attribute":false},"description":"Gets the resources which are associated with this resource (sub-resources)","type":"array","items":{"$ref":"#/components/schemas/ChildServiceResourceOptions","type":"object"}}},"description":"Service resource options","type":"object"},"ServiceResourceCapability":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"cap":{"xml":{"name":"cap","attribute":true},"description":"Gets or sets the capabilities","type":"string","enum":["none","create","create-update","update","delete","patch","get","get-version","history","search"]},"demand":{"xml":{"name":"demand","attribute":false},"description":"Gets or sets the demand","type":"array","items":{"type":"string"}}},"description":"Service resource options","type":"object"},"ChildServiceResourceOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"scope":{"xml":{"name":"scope","attribute":true},"description":"Gets or sets the scope of this object.","type":"string","enum":["instance","class"]},"classification":{"xml":{"name":"classification","attribute":true},"description":"Gets or sets the classification of this object","type":"string","enum":["resource","operation"]},"resource":{"xml":{"name":"resource","attribute":true},"description":"Gets the name of the resource","type":"string"},"cap":{"xml":{"name":"cap","attribute":false},"description":"Gets or sets the operations supported by this resource","type":"array","items":{"$ref":"#/components/schemas/ServiceResourceCapability","type":"object"}},"children":{"xml":{"name":"children","attribute":false},"description":"Gets the resources which are associated with this resource (sub-resources)","type":"array","items":{"$ref":"#/components/schemas/ChildServiceResourceOptions","type":"object"}}},"description":"Child service resource options","type":"object"},"ServiceEndpointOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"The classification of the service (such as HDSI, AMI, IDP, etc.) which this registration represents","type":"string","enum":["hdsi","risi","ami","pixpdq","fhir","v2","gs1","acs","meta","bis","other","app","web"]},"cap":{"xml":{"name":"cap","attribute":true},"description":"The capabilities of this service (compression, bearer authentication, etc.) which is used by clients to negotiate server capacity","type":"string","enum":["none","basic","bearer","compress","nodeauth","cors","viewModel","standardApi","standardApiCors","internalApi","idpApi"]},"security":{"xml":{"name":"security","attribute":true},"description":"Identifies the security methods on the provider","type":"string","enum":["None","Basic","Bearer","ClientCertificate"]},"url":{"xml":{"name":"url","attribute":true},"description":"The URLs where the remote service described by the service type can be accessed","type":"array","items":{"type":"string"}},"contract":{"xml":{"name":"contract","attribute":false},"description":"Gets or sets the contract","type":"array","items":{"$ref":"#/components/schemas/TypeReferenceConfiguration","type":"object"}},"behavior":{"xml":{"name":"behavior","attribute":false},"description":"The service implementation which this remote service implements (which is used to drive metadata collection)","schema":{"$ref":"#/components/schemas/TypeReferenceConfiguration"}}},"description":"Service endpoint options","type":"object"},"TypeReferenceConfiguration":{"xml":{"attribute":false,"namespace":"http://santedb.org/configuration"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"Gets the type","type":"string"}},"description":"Represents a class that can be used to reference types in configuration files","type":"object"},"AppSettingKeyValuePair":{"xml":{"attribute":false,"namespace":"http://santedb.org/configuration"},"properties":{"key":{"xml":{"name":"key","attribute":true},"description":"The key of the setting","type":"string"},"value":{"xml":{"name":"value","attribute":true},"description":"The value of the setting","type":"string"}},"description":"Application key/value pair setting","type":"object"}}}} ``` ## The CarePathwayDefinition object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"CarePathwayDefinition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic for the care pathway","type":"string"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the care pathway","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the care pathway","type":"string"},"eligibility":{"xml":{"name":"eligibility","attribute":false},"description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},"enrollment":{"xml":{"name":"enrollment","attribute":false},"description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},"encounterTemplate":{"xml":{"name":"encounterTemplate","attribute":false},"description":"Gets or sets the type of encounter","type":"string","format":"uuid"},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a single care pathway","type":"object"}}}} ``` ## The Narrative object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Narrative":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"versionCode":{"xml":{"name":"versionCode","attribute":false},"description":"The external version number of the structured document","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"The language in which the document content is written","type":"string"},"mime":{"xml":{"name":"mime","attribute":false},"description":"Gets or sets the mime type of the narrative content","type":"string"},"title":{"xml":{"name":"title","attribute":false},"description":"The title of the clinical document","type":"string"},"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the text of the document","type":"array","items":{"type":"number","format":"byte"}},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a narrative object in the reference model","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The Observation object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Observation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a act (","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The Place object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Place":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"isMobile":{"xml":{"name":"isMobile","attribute":false},"description":"True if location is mobile","type":"boolean"},"service":{"xml":{"name":"service","attribute":false},"description":"Gets the services","type":"array","items":{"$ref":"#/components/schemas/PlaceService","type":"object"}},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"An entity which is a place where healthcare services are delivered","type":"object"},"PlaceService":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"serviceConcept":{"xml":{"name":"serviceConcept","attribute":false},"description":"Gets or sets the service concept key","type":"string","format":"uuid"},"serviceSchedule":{"xml":{"name":"serviceSchedule","attribute":false},"description":"The schedule that the service is offered","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a service for a place","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The IdentityDomain object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"}}}} ``` ## The Patch object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Patch":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"version":{"xml":{"name":"version","attribute":true},"description":"Gets or sets the version of the patch file","type":"string"},"appliesTo":{"xml":{"name":"appliesTo","attribute":false},"description":"Application version","schema":{"$ref":"#/components/schemas/PatchTarget"}},"change":{"xml":{"name":"change","attribute":false},"description":"A list of patch operations to be applied to the object","type":"array","items":{"$ref":"#/components/schemas/PatchOperation","type":"object"}},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a series of patch instructions","type":"object"},"PatchTarget":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"Identifies the target type","type":"string"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the key","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the key","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets or sets the tag of the item","type":"string"}},"description":"Represents a target of a patch","type":"object"},"PatchOperation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"op":{"xml":{"name":"op","attribute":true},"description":"Gets or sets the operation type","type":"string","enum":["add","remove","replace","test","test-ne"]},"path":{"xml":{"name":"path","attribute":true},"description":"Gets or sets the path","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Get or sets the value","schema":{"$ref":"#/components/schemas/Object"}}},"description":"Represents a single patch operation","type":"object"},"Object":{"properties":{},"type":"object"}}}} ``` ## The SubstanceAdministration object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"SubstanceAdministration":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"route":{"xml":{"name":"route","attribute":false},"description":"Gets or sets the key for route","type":"string","format":"uuid"},"doseUnit":{"xml":{"name":"doseUnit","attribute":false},"description":"Gets or sets the key for dosing unit","type":"string","format":"uuid"},"doseQuantity":{"xml":{"name":"doseQuantity","attribute":false},"description":"Gets or sets the amount of substance administered","type":"number","format":"double"},"doseSequence":{"xml":{"name":"doseSequence","attribute":false},"description":"The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)","type":"number","format":"int32"},"site":{"xml":{"name":"site","attribute":false},"description":"Gets or sets the site","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an act whereby a substance is administered to the patient","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The StockLedgerEntry object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"StockLedgerEntry":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this entry in the ledger","type":"number","format":"int64"},"act":{"xml":{"name":"act","attribute":false},"description":"Gets or sets the act which caused this ledger entry to be created","type":"string","format":"uuid"},"container":{"xml":{"name":"container","attribute":false},"description":"Gets or sets the container to which this ledger entry applies","type":"string","format":"uuid"},"material":{"xml":{"name":"material","attribute":false},"description":"Gets or sets the material to which the ledger entry applies","type":"string","format":"uuid"},"reason":{"xml":{"name":"reason","attribute":false},"description":"Gets or sets the reason for the ledger entry","type":"string","format":"uuid"},"startOfLine":{"xml":{"name":"startOfLine","attribute":false},"description":"Gets or sets the start of line balance (the known balance before the entry was created)","type":"number","format":"int32"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Gets or sets the quantity of the current ledger entry","type":"number","format":"int32"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security principal that was responsible for the cretion of this ledger entry","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the time that this ledger entry was created","type":"string"},"timestamp":{"xml":{"name":"timestamp","attribute":false},"description":"Gets or sets the timestamp when the ledger entry applies to","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the modification date of this object entry","type":"string","format":"date"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the stock ledger entry type","type":"string","enum":["ledger","rollback","purged"]},"ref":{"xml":{"name":"ref","attribute":false},"description":"If this entry points to another entry, then the pointer to the entry being referenced","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a stock ledger entry","type":"object"}}}} ``` ## The Person object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Person":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity which is a person","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The Act object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Act":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents the base class for an act (something which is done or actioned on)","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The ReferenceTerm object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ReferenceTerm":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic for the reference term","type":"string"},"codeSystem":{"xml":{"name":"codeSystem","attribute":false},"description":"Gets or sets the code system identifier","type":"string","format":"uuid"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets display names associated with the reference term","type":"array","items":{"$ref":"#/components/schemas/ReferenceTermName","type":"object"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a basic reference term","type":"object"},"ReferenceTermName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"language":{"xml":{"name":"language","attribute":false},"description":"Gets or sets the language code of the object","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the name of the reference term","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Display name of a code system or reference term","type":"object"}}}} ``` ## The PlaceService object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"PlaceService":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"serviceConcept":{"xml":{"name":"serviceConcept","attribute":false},"description":"Gets or sets the service concept key","type":"string","format":"uuid"},"serviceSchedule":{"xml":{"name":"serviceSchedule","attribute":false},"description":"The schedule that the service is offered","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a service for a place","type":"object"}}}} ``` ## The Material object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Material":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"expiryDate":{"xml":{"name":"expiryDate","attribute":false},"description":"Gets or sets the expiry date of the material","type":"string"},"formConcept":{"xml":{"name":"formConcept","attribute":false},"description":"Gets or sets the form concept's key","type":"string","format":"uuid"},"isAdministrable":{"xml":{"name":"isAdministrable","attribute":false},"description":"True if the material is simply administrative","type":"boolean"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n which is a /per ...","type":"number","format":"double"},"quantityConcept":{"xml":{"name":"quantityConcept","attribute":false},"description":"Gets or sets the quantity concept ref","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a material which describes a type of material (i.e. scapel, antigen, etc.) and serves as a base class for manufactured materials","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The ConceptRelationship object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ConceptRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"targetConcept":{"xml":{"name":"targetConcept","attribute":false},"description":"Gets or sets the target concept identifier","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Relationship type","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a relationship between two concepts","type":"object"}}}} ``` ## The RelationshipValidationRule object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"RelationshipValidationRule":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the validation rule was modified on","type":"string","format":"date"},"sourceClass":{"xml":{"name":"sourceClass","attribute":false},"description":"Gets the classification key of the source object to which this classification applies","type":"string","format":"uuid"},"targetClass":{"xml":{"name":"targetClass","attribute":false},"description":"Get the target class key","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Gets the relationship type between the","type":"string","format":"uuid"},"appliesTo":{"xml":{"name":"appliesTo","attribute":false},"description":"Gets or sets the application class for XML","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets the description for the validation","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a relationship validation rule between two","type":"object"}}}} ``` ## The NameValueCollection object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"NameValueCollection":{"properties":{},"type":"object"}}}} ``` ## The CodeSystem object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"CodeSystem":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the code system","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the Oid of the code system","type":"string"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Gets or sets the authority of the code system","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"Gets or sets the URL of the code system","type":"string"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the version text of the code system","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the human description","type":"string"},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a code system which is a collection of reference terms","type":"object"}}}} ``` ## The PatientEncounter object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"PatientEncounter":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"dischargeDisposition":{"xml":{"name":"dischargeDisposition","attribute":false},"description":"Gets or sets the key of discharge disposition","type":"string","format":"uuid"},"admissionSource":{"xml":{"name":"admissionSource","attribute":false},"description":"Gets or sets the admission source type","type":"string","format":"uuid"},"specialArrangement":{"xml":{"name":"specialArrangement","attribute":false},"description":"A list of special arrangements which are to be made to the patient during the encounter","type":"array","items":{"$ref":"#/components/schemas/PatientEncounterArrangement","type":"object"}},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an encounter a patient has with the health system","type":"object"},"PatientEncounterArrangement":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the arrangement made","type":"string","format":"uuid"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Links a","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The ConceptRelationshipType object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ConceptRelationshipType":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the relationship","type":"string"},"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"The invariant of the relationship type","type":"string"},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Concept relationship type","type":"object"}}}} ``` ## The XmlSchema object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"XmlSchema":{"properties":{"include":{"xml":{"name":"include","attribute":false},"type":"array","items":{"type":"object"}},"simpleType":{"xml":{"name":"simpleType","attribute":false},"type":"array","items":{"type":"object"}}},"type":"object"}}}} ``` ## The EntityExtension object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"}}}} ``` ## The ManufacturedMaterial object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ManufacturedMaterial":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"lotNumber":{"xml":{"name":"lotNumber","attribute":false},"description":"Gets or sets the lot number of the manufactured material","type":"string"},"expiryDate":{"xml":{"name":"expiryDate","attribute":false},"description":"Gets or sets the expiry date of the material","type":"string"},"formConcept":{"xml":{"name":"formConcept","attribute":false},"description":"Gets or sets the form concept's key","type":"string","format":"uuid"},"isAdministrable":{"xml":{"name":"isAdministrable","attribute":false},"description":"True if the material is simply administrative","type":"boolean"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"The base quantity of the object in the units. This differs from quantity on the relationship\r\n which is a /per ...","type":"number","format":"double"},"quantityConcept":{"xml":{"name":"quantityConcept","attribute":false},"description":"Gets or sets the quantity concept ref","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a material which is manufactured by a particular organization or company.","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The TemplateDefinition object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"TemplateDefinition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic","type":"string"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or set the name","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the concept set","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description","type":"string"},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a template definition","type":"object"}}}} ``` ## The PatchCollection object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"PatchCollection":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"patch":{"xml":{"name":"patch","attribute":false},"description":"Gets or sets the patches","type":"array","items":{"$ref":"#/components/schemas/Patch","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"type":"string","format":"date"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a collection of patch instructions","type":"object"},"Patch":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"version":{"xml":{"name":"version","attribute":true},"description":"Gets or sets the version of the patch file","type":"string"},"appliesTo":{"xml":{"name":"appliesTo","attribute":false},"description":"Application version","schema":{"$ref":"#/components/schemas/PatchTarget"}},"change":{"xml":{"name":"change","attribute":false},"description":"A list of patch operations to be applied to the object","type":"array","items":{"$ref":"#/components/schemas/PatchOperation","type":"object"}},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a series of patch instructions","type":"object"},"PatchTarget":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"Identifies the target type","type":"string"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the key","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the key","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets or sets the tag of the item","type":"string"}},"description":"Represents a target of a patch","type":"object"},"PatchOperation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"op":{"xml":{"name":"op","attribute":true},"description":"Gets or sets the operation type","type":"string","enum":["add","remove","replace","test","test-ne"]},"path":{"xml":{"name":"path","attribute":true},"description":"Gets or sets the path","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Get or sets the value","schema":{"$ref":"#/components/schemas/Object"}}},"description":"Represents a single patch operation","type":"object"},"Object":{"properties":{},"type":"object"}}}} ``` ## The Provider object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Provider":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"providerSpecialty":{"xml":{"name":"providerSpecialty","attribute":false},"description":"Gets or sets the provider specialty key","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a provider role of a person","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The Entity object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Entity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents the base class of all entities (persons, places, things) in SanteDB","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The ConceptReferenceTerm object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ConceptReferenceTerm":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"term":{"xml":{"name":"term","attribute":false},"description":"Gets or sets the reference term identifier","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Gets or sets the relationship type identifier","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a reference term relationship between a concept and reference term","type":"object"}}}} ``` ## The Concept object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Concept":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the unchanging mnemonic for the concept","type":"string"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Gets or sets the status concept key","type":"string","format":"uuid"},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of concept relationships","type":"array","items":{"$ref":"#/components/schemas/ConceptRelationship","type":"object"}},"conceptClass":{"xml":{"name":"conceptClass","attribute":false},"description":"Gets or sets the class identifier","type":"string","format":"uuid"},"referenceTerm":{"xml":{"name":"referenceTerm","attribute":false},"description":"Gets a list of concept reference terms","type":"array","items":{"$ref":"#/components/schemas/ConceptReferenceTerm","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets the concept names","type":"array","items":{"$ref":"#/components/schemas/ConceptName","type":"object"}},"conceptSet":{"xml":{"name":"conceptSet","attribute":false},"description":"Concept sets as identifiers for XML purposes only","type":"array","items":{"type":"string","format":"uuid"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the concept","type":"array","items":{"$ref":"#/components/schemas/ConceptTag","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the concept","type":"array","items":{"$ref":"#/components/schemas/ConceptExtension","type":"object"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A class representing a generic concept used in the SanteDB datamodel","type":"object"},"ConceptRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"targetConcept":{"xml":{"name":"targetConcept","attribute":false},"description":"Gets or sets the target concept identifier","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Relationship type","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a relationship between two concepts","type":"object"},"ConceptReferenceTerm":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"term":{"xml":{"name":"term","attribute":false},"description":"Gets or sets the reference term identifier","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Gets or sets the relationship type identifier","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a reference term relationship between a concept and reference term","type":"object"},"ConceptName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"language":{"xml":{"name":"language","attribute":false},"description":"Gets or sets the language code of the object","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the name of the reference term","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name (human name) that a concept may have","type":"object"},"ConceptTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an concept","type":"object"},"ConceptExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"}}}} ``` ## The ApplicationEntity object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ApplicationEntity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"securityApplication":{"xml":{"name":"securityApplication","attribute":false},"description":"Gets or sets the security application","type":"string","format":"uuid"},"softwareName":{"xml":{"name":"softwareName","attribute":false},"description":"Gets or sets the name of the software","type":"string"},"vendorName":{"xml":{"name":"vendorName","attribute":false},"description":"Gets or sets the vendoer name of the software","type":"string"},"versionName":{"xml":{"name":"versionName","attribute":false},"description":"Gets or sets the version of the software","type":"string"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents the clinical data object for Applications","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The ExtensionType object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ExtensionType":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"handlerClass":{"xml":{"name":"handlerClass","attribute":false},"description":"Gets or sets the description","type":"string"},"uri":{"xml":{"name":"uri","attribute":false},"description":"Gets or sets the uri of the extension","type":"string"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the extension","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Instructions on how an extensionshould be handled","type":"object"}}}} ``` ## The RestServiceFault object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}}} ``` ## The ParameterCollection object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ParameterCollection":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"parameter":{"xml":{"name":"parameter","attribute":false},"description":"Gets or sets the parameters","type":"array","items":{"$ref":"#/components/schemas/Parameter","type":"object"}}},"description":"Gets the operation invokation","type":"object"},"Parameter":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the operation","type":"string"},"int":{"xml":{"name":"int","attribute":false},"description":"Gets or sets the value of the parameter","schema":{"$ref":"#/components/schemas/Object"}}},"description":"REST service fault wrapper","type":"object"},"Object":{"properties":{},"type":"object"}}}} ``` ## The CarePlan object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"CarePlan":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"title":{"xml":{"name":"title","attribute":false},"description":"Gets or sets a human title for the care plan","type":"string"},"pathway":{"xml":{"name":"pathway","attribute":false},"description":"Identifies the care pathway identifier which this care plan is generated for","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a care plan","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The Procedure object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Procedure":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"method":{"xml":{"name":"method","attribute":false},"description":"Gets or sets te method/technique used to perform the procedure","type":"string","format":"uuid"},"approachSite":{"xml":{"name":"approachSite","attribute":false},"description":"Gets or sets the anatomical site or system through which the procedure was performed","type":"string","format":"uuid"},"targetSite":{"xml":{"name":"targetSite","attribute":false},"description":"Gets or sets the anatomical site or system which is the target of the procedure","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a class which has an immediate and primary outcome and is an alteration\r\n of the physical condition of the subject.","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The TextObservation object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"TextObservation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"valueType":{"xml":{"name":"valueType","attribute":false},"description":"Value type","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the textual value","type":"string"},"interpretationConcept":{"xml":{"name":"interpretationConcept","attribute":false},"description":"Gets or sets the interpretation concept","type":"string","format":"uuid"},"isNegated":{"xml":{"name":"isNegated","attribute":false},"description":"Identifies whether the act represented in this instance actually occurred","type":"boolean"},"template":{"xml":{"name":"template","attribute":false},"description":"The template on which the act is based","type":"string","format":"uuid"},"actTime":{"xml":{"name":"actTime","attribute":false},"description":"The moment in time that this act occurred in ISO format","type":"string"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"The classification key of the activity","type":"string","format":"uuid"},"moodConcept":{"xml":{"name":"moodConcept","attribute":false},"description":"The mood (or mode) of the Act instance","type":"string","format":"uuid"},"reasonConcept":{"xml":{"name":"reasonConcept","attribute":false},"description":"Identifies a codified reason as to why this act did (or did not, or should or should not) occur.","type":"string","format":"uuid"},"obsoletionReason":{"xml":{"name":"obsoletionReason","attribute":false},"description":"Gets or sets the reason why the act was obsoleted/deleted","type":"string","format":"uuid"},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"The concept which describes the current status of the act","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Gets or sets the key of the concept which further classifies the type of act occurring","type":"string","format":"uuid"},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Identifiers by which this act is known","type":"array","items":{"$ref":"#/components/schemas/ActIdentifier","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated acts for this act","type":"array","items":{"$ref":"#/components/schemas/ActRelationship","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the act","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActExtension","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActNote","type":"object"}},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the act","type":"array","items":{"$ref":"#/components/schemas/ActTag","type":"object"}},"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Identifies protocols attached to the act","type":"array","items":{"$ref":"#/components/schemas/ActProtocol","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets or sets the entities and participations they play in the act","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo-tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an observation with a text value","type":"object"},"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"ActRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"type":"number","format":"int64"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Used to link two or more acts together","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"},"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"},"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The UserEntity object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"UserEntity":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"securityUser":{"xml":{"name":"securityUser","attribute":false},"description":"Gets or sets the security user key","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a user entity","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The SecurityPolicyInstance object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a security policy instance","type":"object"}}}} ``` ## The EntityName object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"}}}} ``` ## The ActParticipation object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates an entity which participates in an act","type":"object"}}}} ``` ## The EntityTag object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an entity","type":"object"}}}} ``` ## The EntityAddress object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"}}}} ``` ## The EntityIdentifier object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"}}}} ``` ## The EntityTelecomAddress object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents an entity telecom address","type":"object"}}}} ``` ## The ConceptTag object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ConceptTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag associated with an concept","type":"object"}}}} ``` ## The ReferenceTermName object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ReferenceTermName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"language":{"xml":{"name":"language","attribute":false},"description":"Gets or sets the language code of the object","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the name of the reference term","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Display name of a code system or reference term","type":"object"}}}} ``` ## The ActNote object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ActNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"}}}} ``` ## The ActIdentifier object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ActIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act identifier","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"}}}} ``` ## The ServiceResourceOptions object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ServiceResourceOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"resource":{"xml":{"name":"resource","attribute":true},"description":"Gets the name of the resource","type":"string"},"cap":{"xml":{"name":"cap","attribute":false},"description":"Gets or sets the operations supported by this resource","type":"array","items":{"$ref":"#/components/schemas/ServiceResourceCapability","type":"object"}},"children":{"xml":{"name":"children","attribute":false},"description":"Gets the resources which are associated with this resource (sub-resources)","type":"array","items":{"$ref":"#/components/schemas/ChildServiceResourceOptions","type":"object"}}},"description":"Service resource options","type":"object"},"ServiceResourceCapability":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"cap":{"xml":{"name":"cap","attribute":true},"description":"Gets or sets the capabilities","type":"string","enum":["none","create","create-update","update","delete","patch","get","get-version","history","search"]},"demand":{"xml":{"name":"demand","attribute":false},"description":"Gets or sets the demand","type":"array","items":{"type":"string"}}},"description":"Service resource options","type":"object"},"ChildServiceResourceOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"scope":{"xml":{"name":"scope","attribute":true},"description":"Gets or sets the scope of this object.","type":"string","enum":["instance","class"]},"classification":{"xml":{"name":"classification","attribute":true},"description":"Gets or sets the classification of this object","type":"string","enum":["resource","operation"]},"resource":{"xml":{"name":"resource","attribute":true},"description":"Gets the name of the resource","type":"string"},"cap":{"xml":{"name":"cap","attribute":false},"description":"Gets or sets the operations supported by this resource","type":"array","items":{"$ref":"#/components/schemas/ServiceResourceCapability","type":"object"}},"children":{"xml":{"name":"children","attribute":false},"description":"Gets the resources which are associated with this resource (sub-resources)","type":"array","items":{"$ref":"#/components/schemas/ChildServiceResourceOptions","type":"object"}}},"description":"Child service resource options","type":"object"}}}} ``` ## The PersonLanguageCommunication object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a single preferred communication method for the entity","type":"object"}}}} ``` ## The ActExtension object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ActExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Act extension","type":"object"}}}} ``` ## The IdentifiedData object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","type":"object"}}}} ``` ## The DetectedIssue object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}}} ``` ## The AppSettingKeyValuePair object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"AppSettingKeyValuePair":{"xml":{"attribute":false,"namespace":"http://santedb.org/configuration"},"properties":{"key":{"xml":{"name":"key","attribute":true},"description":"The key of the setting","type":"string"},"value":{"xml":{"name":"value","attribute":true},"description":"The value of the setting","type":"string"}},"description":"Application key/value pair setting","type":"object"}}}} ``` ## The GeoTag object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a simple geographic tagging attribute","type":"object"}}}} ``` ## The ActTag object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ActTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a tag on an act","type":"object"}}}} ``` ## The PatchOperation object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"PatchOperation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"op":{"xml":{"name":"op","attribute":true},"description":"Gets or sets the operation type","type":"string","enum":["add","remove","replace","test","test-ne"]},"path":{"xml":{"name":"path","attribute":true},"description":"Gets or sets the path","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Get or sets the value","schema":{"$ref":"#/components/schemas/Object"}}},"description":"Represents a single patch operation","type":"object"},"Object":{"properties":{},"type":"object"}}}} ``` ## The AssigningAuthority object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"}}}} ``` ## The PatientEncounterArrangement object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"PatientEncounterArrangement":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the arrangement made","type":"string","format":"uuid"},"startTime":{"xml":{"name":"startTime","attribute":false},"description":"The time when the act should or did start ocurring in ISO format","type":"string"},"stopTime":{"xml":{"name":"stopTime","attribute":false},"description":"The time when the act should or did stop ocurring in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Links a","type":"object"}}}} ``` ## The Parameter object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"Parameter":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the operation","type":"string"},"int":{"xml":{"name":"int","attribute":false},"description":"Gets or sets the value of the parameter","schema":{"$ref":"#/components/schemas/Object"}}},"description":"REST service fault wrapper","type":"object"},"Object":{"properties":{},"type":"object"}}}} ``` ## The ConceptName object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ConceptName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"language":{"xml":{"name":"language","attribute":false},"description":"Gets or sets the language code of the object","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the name of the reference term","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name (human name) that a concept may have","type":"object"}}}} ``` ## The ActProtocol object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ActProtocol":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"protocol":{"xml":{"name":"protocol","attribute":false},"description":"Gets or sets the protocol to which this act belongs","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets the version of the protocol that was used to generate the","type":"string"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Represents the sequence of the act in the protocol","type":"number","format":"int32"},"state":{"xml":{"name":"state","attribute":false},"description":"Represents any state data related to the act / protocol link","type":"array","items":{"type":"number","format":"byte"}},"notBefore":{"xml":{"name":"notBefore","attribute":false},"description":"Not before XML representation","type":"string"},"notAfter":{"xml":{"name":"notAfter","attribute":false},"description":"Not before XML representation","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents information related to the clinical protocol to which an act is a member of","type":"object"}}}} ``` ## The EntityNote object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a note attached to an entity","type":"object"}}}} ``` ## The ConceptSetComposition object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ConceptSetComposition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"instruction":{"xml":{"name":"instruction","attribute":false},"description":"The composition operation","type":"string","enum":["include","exclude"]},"target":{"xml":{"name":"target","attribute":false},"description":"Gets the target of the composition","type":"string","format":"uuid"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a reference between two different concept sets","type":"object"}}}} ``` ## The ServiceEndpointOptions object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ServiceEndpointOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"The classification of the service (such as HDSI, AMI, IDP, etc.) which this registration represents","type":"string","enum":["hdsi","risi","ami","pixpdq","fhir","v2","gs1","acs","meta","bis","other","app","web"]},"cap":{"xml":{"name":"cap","attribute":true},"description":"The capabilities of this service (compression, bearer authentication, etc.) which is used by clients to negotiate server capacity","type":"string","enum":["none","basic","bearer","compress","nodeauth","cors","viewModel","standardApi","standardApiCors","internalApi","idpApi"]},"security":{"xml":{"name":"security","attribute":true},"description":"Identifies the security methods on the provider","type":"string","enum":["None","Basic","Bearer","ClientCertificate"]},"url":{"xml":{"name":"url","attribute":true},"description":"The URLs where the remote service described by the service type can be accessed","type":"array","items":{"type":"string"}},"contract":{"xml":{"name":"contract","attribute":false},"description":"Gets or sets the contract","type":"array","items":{"$ref":"#/components/schemas/TypeReferenceConfiguration","type":"object"}},"behavior":{"xml":{"name":"behavior","attribute":false},"description":"The service implementation which this remote service implements (which is used to drive metadata collection)","schema":{"$ref":"#/components/schemas/TypeReferenceConfiguration"}}},"description":"Service endpoint options","type":"object"},"TypeReferenceConfiguration":{"xml":{"attribute":false,"namespace":"http://santedb.org/configuration"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"Gets the type","type":"string"}},"description":"Represents a class that can be used to reference types in configuration files","type":"object"}}}} ``` ## The PatchTarget object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"PatchTarget":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"Identifies the target type","type":"string"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the key","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the key","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets or sets the tag of the item","type":"string"}},"description":"Represents a target of a patch","type":"object"}}}} ``` ## The ChildServiceResourceOptions object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ChildServiceResourceOptions":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"scope":{"xml":{"name":"scope","attribute":true},"description":"Gets or sets the scope of this object.","type":"string","enum":["instance","class"]},"classification":{"xml":{"name":"classification","attribute":true},"description":"Gets or sets the classification of this object","type":"string","enum":["resource","operation"]},"resource":{"xml":{"name":"resource","attribute":true},"description":"Gets the name of the resource","type":"string"},"cap":{"xml":{"name":"cap","attribute":false},"description":"Gets or sets the operations supported by this resource","type":"array","items":{"$ref":"#/components/schemas/ServiceResourceCapability","type":"object"}},"children":{"xml":{"name":"children","attribute":false},"description":"Gets the resources which are associated with this resource (sub-resources)","type":"array","items":{"$ref":"#/components/schemas/ChildServiceResourceOptions","type":"object"}}},"description":"Child service resource options","type":"object"},"ServiceResourceCapability":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"cap":{"xml":{"name":"cap","attribute":true},"description":"Gets or sets the capabilities","type":"string","enum":["none","create","create-update","update","delete","patch","get","get-version","history","search"]},"demand":{"xml":{"name":"demand","attribute":false},"description":"Gets or sets the demand","type":"array","items":{"type":"string"}}},"description":"Service resource options","type":"object"}}}} ``` ## The ServiceResourceCapability object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"ServiceResourceCapability":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"cap":{"xml":{"name":"cap","attribute":true},"description":"Gets or sets the capabilities","type":"string","enum":["none","create","create-update","update","delete","patch","get","get-version","history","search"]},"demand":{"xml":{"name":"demand","attribute":false},"description":"Gets or sets the demand","type":"array","items":{"type":"string"}}},"description":"Service resource options","type":"object"}}}} ``` ## The EntityNameComponent object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a name component which is bound to a name","type":"object"}}}} ``` ## The TypeReferenceConfiguration object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"TypeReferenceConfiguration":{"xml":{"attribute":false,"namespace":"http://santedb.org/configuration"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"Gets the type","type":"string"}},"description":"Represents a class that can be used to reference types in configuration files","type":"object"}}}} ``` ## The AddressComponent object ```json {"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"components":{"schemas":{"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"A single address component","type":"object"}}}} ```