Skip to content
Partner Developer Portal byOptum

Schema

Column NameDescriptionExample
is_deletedFlag indicating if the sharing agreement record has been deletedFALSE
agreement_guidUUID identifier for the sharing agreementD0AD76B9-200B-4D52-8199-8D8F485EB1D7
requester_organisation_guidUUID identifier for the requester organisationA1B2C3D4-1234-5678-9ABC-DEF012345678
sharer_organisation_guidUUID identifier for the sharer organisationE5F6G7H8-9012-3456-7890-ABCDEF123456
user_idUser ID assigned to the agreement12345
can_processFlag indicating if data can be processed under this agreement (NULL if deleted)TRUE
requester_statusStatus of the requester organisation (NULL if deleted)Activated
requester_cdbRequester organisation CDB number (NULL if deleted)50001
requester_nameRequester organisation name (NULL if deleted)Requester Health Trust
agreement_statusAgreement enabled/disabled status (NULL if deleted)Enabled
agreement_type_idAgreement type identifier (NULL if deleted)5
agreement_type_descriptionAgreement type description (NULL if deleted)Standard Data Sharing
agreement_idAgreement identifier (NULL if deleted)1001
agreement_nameAgreement name (NULL if deleted)Regional Care Agreement
agreement_purposeAgreement purpose description (NULL if deleted)To facilitate integrated care
sharer_statusStatus of the sharer organisation (NULL if deleted)02. Activated
org_typeOrganisation type classification (NULL if deleted)GP Practice
sharer_odsSharer organisation ODS code (NULL if deleted)Y12345
sharer_cdbSharer organisation CDB number (NULL if deleted)50002
sharer_nameSharer organisation name (NULL if deleted)Example GP Surgery
sharer_closedateDate when the sharer organisation closed (NULL if deleted or not closed)2024-12-31 00:00:00
patient_countTotal patient count for the sharer organisation (NULL if deleted)8500
active_patient_countActive patient count for the sharer organisation (NULL if deleted)7800
active_user_countActive user count for the sharer organisation (NULL if deleted)25
sharer_environmentEnvironment description for the sharer organisation (NULL if deleted)Production
lastmodified_datetimeTimestamp when the agreement was last modified (NULL if deleted)2024-09-17 08:48:00
lastmodified_dateDate when the agreement was last modified (NULL if deleted)2024-09-17
extract_dateDate of data extract (NULL if deleted)2024-09-17
cognito_usernameCognito username for the user assigned to the agreement (NULL if deleted)john.smith
organisationOrganisation assignment for the record (‘EMIS’ for deleted records, otherwise sharer organisation)CDB-50002
transform_datetimeTimestamp when the record was transformed in the data pipeline2024-09-17 08:48:00.123456 +00:00
_execution_dateETL execution date in format yyyyMMddHHmmss20240917084800

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarcharNo longer available/required in v2 for this model
is_deletedbooleandeletedExists in v1 with a different name
agreement_guidvarchar
emis_organisation_guidvarchar
namevarchar
ods_codevarchar
organisation_cdbvarchar
is_activated_flagboolean
disabledboolean
last_modified_datedate
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarcharNo longer available/required in v2 for this model
is_deletedbooleandeletedExists in v1 with a different name
agreement_guidvarchar
emis_organisation_guidvarchar
ods_codevarchar
namevarchar
organisation_cdbvarchar
is_activated_flagboolean
disabledboolean
last_modified_datedate
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar(14)

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarcharNo longer available/required in v2 for this model
is_deletedbooleandeletedExists in v1 with a different name
agreement_guidvarchar
emis_organisation_guidvarchar
namevarchar
ods_codevarchar
organisation_cdbvarchar
is_activated_flagboolean
disabledboolean
last_modified_datedate
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarcharNo longer available/required in v2 for this model
is_deletedbooleandeletedExists in v1 with a different name
agreement_guidvarchar
emis_organisation_guidvarchar
namevarchar
ods_codevarchar
organisation_cdbvarchar
is_activated_flagboolean
disabledboolean
last_modified_datedate
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarcharNo longer available/required in v2 for this model
is_deletedbooleandeleted Exists in v1 with a different name
agreement_guidvarchar
namevarchar
emis_organisation_guidvarchar
ods_codevarchar
organisation_cdbvarchar
is_activated_flagboolean
disabledboolean
last_modified_datedate
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarcharNo longer available/required in v2 for this model
is_deletedbooleandeletedExists in v1 with a different name
agreement_guidvarchar
namevarchar
emis_organisation_guidvarchar
ods_codevarchar
organisation_cdbvarchar
is_activated_flagboolean
disabledboolean
last_modified_datedate
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarcharNo longer available/required in v2 for this model
is_deletedbooleandeletedExists in v1 with a different name
agreement_guidvarchar
emis_organisation_guidvarchar
namevarchar
ods_codevarchar
organisation_cdbvarchar
is_activated_flagboolean
disabledboolean
last_modified_datedate
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarcharNo longer available/required in v2 for this model
is_deletedbooleandeletedExists in v1 with a different name
agreement_guidvarchar
emis_organisation_guidvarchar
namevarchar
ods_codevarchar
organisation_cdbvarchar
last_modified_datedate
is_activated_flagboolean
disabledboolean
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Not used in this schema