Community data FHIR mapping: Difference between revisions

From Discovery Data Service
Jump to navigation Jump to search
No edit summary
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
To see the latest Compass V2 schema, please see [[Discovery Remote Subscriber Database Familiarisation#Data_Mapping]]
== Organisation ==
== Organisation ==


=== Organisation ===
=== Organisation ===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Field Name
Line 19: Line 24:
|Customer number
|Customer number
|Organization::Identifier::Value  (use=secondary, system=cdb-number)
|Organization::Identifier::Value  (use=secondary, system=cdb-number)
|
| -
|
| -
|-
|-
|OrganisationName
|OrganisationName
Line 43: Line 48:
|Links to Organisation  - Organisation - OrganisationGuid
|Links to Organisation  - Organisation - OrganisationGuid
|Organization::PartOf::Reference *
|Organization::PartOf::Reference *
|
| -
|
| -
|-
|-
|OrganisationType
|OrganisationType
|Type of organisation
|Type of organisation
|Organization::Type***
|Organization::Type
|organization
|organization
|type_desc
|type_desc
Line 55: Line 60:
|Date organisation  opened
|Date organisation  opened
|Organization::primarycare-activeperiod-extension::ValuePeriod::Start
|Organization::primarycare-activeperiod-extension::ValuePeriod::Start
|
| -
|
| -
|-
|-
|CloseDate
|CloseDate
|Date organisation  closed
|Date organisation  closed
|Organization::primarycare-activeperiod-extension::ValuePeriod::End
|Organization::primarycare-activeperiod-extension::ValuePeriod::End
|
| -
|
| -
|-
|-
|MainLocationGuid
|MainLocationGuid
|Link to Organisation  - Location - LocationGuid
|Link to Organisation  - Location - LocationGuid
|Organization::primarycare-mainlocation-extension::ValueReference*
|Organization::primarycare-mainlocation-extension::ValueReference*
|
| -
|
| -
|-
|
|
|
|
|
|}
|}


=== Location ===
===Location===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Field Name
Line 113: Line 115:
|Open Date
|Open Date
|Location::primarycare-activeperiod-extension::ValuePeriod::Start
|Location::primarycare-activeperiod-extension::ValuePeriod::Start
|
| -
|
| -
|-
|-
|CloseDate
|CloseDate
|Close Date
|Close Date
|Location::primarycare-activeperiod-extension::ValuePeriod::End
|Location::primarycare-activeperiod-extension::ValuePeriod::End
|
| -
|
| -
|-
|-
|MainContactName
|MainContactName
|Main contact name
|Main contact name
|Location::primarycare-location-main-contact-extension::String
|Location::primarycare-location-main-contact-extension::String
|
| -
|
| -
|-
|-
|FaxNumber
|FaxNumber
|Fax number
|Fax number
|Location::contactPoint::fax (use=work,  system=fax)
|Location::contactPoint::fax (use=work,  system=fax)
|
| -
|
| -
|-
|-
|EmailAddress
|EmailAddress
|Email adress
|Email adress
|Location::contactPoint::email  (use=work, system=email)
|Location::contactPoint::email  (use=work, system=email)
|
| -
|
| -
|-
|-
|PhoneNumber
|PhoneNumber
|Phone number
|Phone number
|Location::contactPoint::phone  (use=work, system=phone)
|Location::contactPoint::phone  (use=work, system=phone)
|
| -
|
| -
|-
|-
|HouseNameFlatNumber
|HouseNameFlatNumber
|Address name/flat  number
|Address name/flat  number
|Location::Address::Line
|Location::Address::Line
|
| -
|
| -
|-
|-
|NumberAndStreet
|NumberAndStreet
|Address street
|Address street
|Location::Address::Line
|Location::Address::Line
|
| -
|
| -
|-
|-
|Village
|Village
|Address village
|Address village
|Location::Address::Line
|Location::Address::Line
|
| -
|
| -
|-
|-
|Town
|Town
|Address town
|Address town
|Location::Address::City
|Location::Address::City
|
| -
|
| -
|-
|-
|County
|County
|Address county
|Address county
|Location::Address::District
|Location::Address::District
|
| -
|
| -
|-
|-
|Postcode
|Postcode
Line 183: Line 185:
|}
|}


=== Organisation Location (used to associate a location with an organisation) ===
===Organisation Location (used to associate a location with an organisation)===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Field Name
Line 195: Line 200:
|Unique ID
|Unique ID
|ManagingOrganization*
|ManagingOrganization*
|
| -
|
| -
|-
|-
|LocationGuid
|LocationGuid
|Link to Organisation  - Location -  LocationGuid
|Link to Organisation  - Location -  LocationGuid
|<used to match to the corresponding  FHIR Location>
|<used to match to the corresponding  FHIR Location>
|
| -
|
| -
|-
|-
|IsMainLocation
|IsMainLocation
|Flag to indicate if  this is the main location
|Flag to indicate if  this is the main location
|<used to order the  ManagingOrganization references>
|<used to order the  ManagingOrganization references>
|
| -
|
| -
|}
|}


== Patient Demographics ==
==Patient Demographics==


{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Field Name
Line 233: Line 241:
|organization_id
|organization_id
|-
|-
|NhsNumber
|NHSNumber
|NHS number
|NHS number
|Patient::Identifier::Value  (use=official, system=nhs-number)
|Patient::Identifier::Value  (use=official, system=nhs-number)
Line 254: Line 262:
|Is a dummy patient
|Is a dummy patient
|Patient::patient-is-test-patient-extension::ValueBoolean  (extension is only created if value is true)
|Patient::patient-is-test-patient-extension::ValueBoolean  (extension is only created if value is true)
|
| -
|
| -
|-
|-
|Title
|Title
Line 386: Line 394:
|The location where  the patient was born
|The location where  the patient was born
|n/a
|n/a
|
| -
|
| -
|-
|-
|SpeaksEnglish
|SpeaksEnglish
|Defines if the  patient speaks English
|Defines if the  patient speaks English
|Patient::patient-speaks-english-extension::ValueBoolean  (extension is only created if value is true)
|Patient::patient-speaks-english-extension::ValueBoolean  (extension is only created if value is true)
|
| -
|
| -
|-
|-
|Deleted
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|
| -
|
| -
|
| -
|}
|}


== Patient Relationship ==
==Patient Relationship (if available)==


{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Field Name
Line 415: Line 426:
|The  relationship type (for example husband or key worker)
|The  relationship type (for example husband or key worker)
|Patient::contact::codeableConcept::text
|Patient::contact::codeableConcept::text
|
| -
|
| -
|-
|-
|DateStarted
|DateStarted
|The date and time  that the relationship started
|The date and time  that the relationship started
|Patient::contact::Period.start
|Patient::contact::Period.start
|
| -
|
| -
|-
|-
|DateEnded
|DateEnded
|The date and time  that the relationship was ended
|The date and time  that the relationship was ended
|Patient::contact::Period.end
|Patient::contact::Period.end
|
| -
|
| -
|-
|-
|NextOfKin
|NextOfKin
|Defines if this is a  next of kin relationship
|Defines if this is a  next of kin relationship
|Patient::patient-contact-is-next-of-kin::ValueBoolean  (extension is only created if value is true)
|Patient::patient-contact-is-next-of-kin::ValueBoolean  (extension is only created if value is true)
|
| -
|
| -
|-
|-
|CaresForPatient
|CaresForPatient
|Defines whether the  relation cares for the patient
|Defines whether the  relation cares for the patient
|Patient::patient-contact-is-carer::ValueBoolean  (extension is only created if value is true)
|Patient::patient-contact-is-carer::ValueBoolean  (extension is only created if value is true)
|
| -
|
| -
|-
|-
|PrincipalCarerForPatient
|PrincipalCarerForPatient
|Defines whether the  relation is the principal carer for the patient
|Defines whether the  relation is the principal carer for the patient
|Patient::patient-contact-is-carer::ValueBoolean  (extension is only created if value is true)
|Patient::patient-contact-is-carer::ValueBoolean  (extension is only created if value is true)
|
| -
|
| -
|-
|-
|RelationshipWithName
|RelationshipWithName
|The name of the  person the relationship is with
|The name of the  person the relationship is with
|Patient::contact::name::text
|Patient::contact::name::text
|
| -
|
| -
|-
|-
|RelationshipWithDateOfBirth
|RelationshipWithDateOfBirth
|The date of birth of  the person the relationship is with
|The date of birth of  the person the relationship is with
|n/a
|n/a
|
| -
|
| -
|-
|-
|RelationshipWithHouseName
|RelationshipWithHouseName
|The house name part  of the address of the person the relationship is with
|The house name part  of the address of the person the relationship is with
|Patient::contact::Address::Line
|Patient::contact::Address::Line
|
| -
|
| -
|-
|-
|RelationshipWithHouseNumber
|RelationshipWithHouseNumber
|The house number part  of the address of the person the relationship is with
|The house number part  of the address of the person the relationship is with
|Patient::contact::Address::Line
|Patient::contact::Address::Line
|
| -
|
| -
|-
|-
|RelationshipWithRoad
|RelationshipWithRoad
|The road part of the  address of the person the relationship is with
|The road part of the  address of the person the relationship is with
|Patient::contact::Address::Line
|Patient::contact::Address::Line
|
| -
|
| -
|-
|-
|RelationshipWithLocality
|RelationshipWithLocality
|The locality part of  the address of the person the relationship is with
|The locality part of  the address of the person the relationship is with
|Patient::contact::Address::Line
|Patient::contact::Address::Line
|
| -
|
| -
|-
|-
|RelationshipWithPostTown
|RelationshipWithPostTown
|The post town part of  the address of the person the relationship is with
|The post town part of  the address of the person the relationship is with
|Patient::contact::Address::City
|Patient::contact::Address::City
|
| -
|
| -
|-
|-
|RelationshipWithCounty
|RelationshipWithCounty
|The county part of  the address of the person the relationship is with
|The county part of  the address of the person the relationship is with
|Patient::contact::Address::District
|Patient::contact::Address::District
|
| -
|
| -
|-
|-
|RelationshipWithPostCode
|RelationshipWithPostCode
|The post code of the  person the relationship is with
|The post code of the  person the relationship is with
|Patient::contact::Address::PostalCode
|Patient::contact::Address::PostalCode
|
| -
|
| -
|-
|-
|RelationshipWithTelephone
|RelationshipWithTelephone
|The telephone number  of the person the relationship is with
|The telephone number  of the person the relationship is with
|Patient::contact::contactPoint::phone  (use=home, system=phone)
|Patient::contact::contactPoint::phone  (use=home, system=phone)
|
| -
|
| -
|-
|-
|RelationshipWithWorkTelephone
|RelationshipWithWorkTelephone
|The work telephone  number of the person the relationship is with
|The work telephone  number of the person the relationship is with
|Patient::contact::contactPoint::phone  (use=work, system=phone)
|Patient::contact::contactPoint::phone  (use=work, system=phone)
|
| -
|
| -
|-
|-
|RelationshipWithMobileTelephone
|RelationshipWithMobileTelephone
|The mobile telephone  number of the person the relationship is with
|The mobile telephone  number of the person the relationship is with
|Patient::contact::contactPoint::phone  (use=mobile, system=phone)
|Patient::contact::contactPoint::phone  (use=mobile, system=phone)
|
| -
|
| -
|-
|-
|RelationshipWithFax
|RelationshipWithFax
|The fax number of the  person the relationship is with
|The fax number of the  person the relationship is with
|Patient::contact::contactPoint::fax  (system=fax)
|Patient::contact::contactPoint::fax  (system=fax)
|
| -
|
| -
|-
|-
|RelationshipWithEmailAddress
|RelationshipWithEmailAddress
|The email address of  the person the relationship is with
|The email address of  the person the relationship is with
|Patient::contact::contactPoint::email  (system=email)
|Patient::contact::contactPoint::email  (system=email)
|
| -
|
| -
|-
|-
|IDPatient
|IDPatient
|Links to  Patient_Demographics - PatientGuid
|Links to  Patient_Demographics - PatientGuid
|Patient::Id*
|Patient::Id*
| -
| -
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
| -
| -
| -
|}
==Registration==
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|PatientGuid
|Unique patient  ID
|Patient::Id*
EpisodeOfCare::Id*
|episode_of_care
registration_status_history
|patient_id
patient_id
|-
|OrganisationGuid
|Links to Organisation  - Organisation - OrganisationGuid
|EpisodeOfCare::ManagingOrganization::Reference  *
|episode_of_care
registration_status_history
|organization_id
organization_id
|-
|DateOfRegistration
|Date of registration
|EpisodeOfCare::Period::Start
|episode_of_care
registration_status_history
|date_registered
start_date
|-
|DateofDeactivation
|Date that the  patient's registration became inactive
|EpisodeOfCare::Period::End
|episode_of_care
registration_status_history
|date_registered_end
end_date
|-
|RegistrationStatus
|The patient's  registration status.
|EpisodeOfCare::primarycare-patient-registration-type-extension::ValueCodeableConcept***
|episode_of_care
|registration_type_concept_id
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|<If true,  all FHIR resources for this patient are deleted>
| -
| -
|-
|ExternalUsualGPGuid
|Unique ID for  External Usual GP
|Patient::CareProvider::Reference  *
| -
| -
|-
|ExternalUsualGPOrganisation
|Link to Organisation  - Organisation - OrganisationGuid
|EpisodeOfCare ::ManagingOrganization::Reference  *
|patient
|registered_practice_organization_id
|-
|SpineMatched
|Defines if the  patients NHS number has been matched on the Spine
|Patient::primarycare-nhs-number-verification-status-extension::Value  (NHS Verification Status)
| -
| -
|}
==User==
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|UserInRoleGuid  (IDStaffMember)
|Unique  ID
|Practitioner::Id*
|practitioner
|id
|-
|OrganisationGuid
|Link to  Organisation - Organisation - OrganisationGuid
|Practitioner::Role::ManagingOrganisation::Reference  *
|practitioner
|organization_id
|-
|Title
|Title
|Practitioner::Name::Prefix
|practitioner
|name
|-
|GivenName
|Forename
|Practitioner::Name::Given
|practitioner
|name
|-
|Surname
|Surname
|Practitioner::Name::Family
|practitioner
|name
|-
|JobCategoryCode
|Job category  code
|Practitioner::Role::Role::Code
|practitioner
|role_code
|-
|JobCategoryName  (StaffRole)
|Job category  name
|Practitioner::Role::Role::Display
|practitioner
|role_desc
|-
|ContractStartDate  (DateEmploymentStart)
|Date contract  started / The date the staff member started
|Practitioner::Role::Period::Start
| -
| -
|-
|ContractEndDate  (DateEmploymentEnd)
|Date contract  ended / The date the staff member was archived
|Practitioner::Role::Period::End
| -
| -
|-
|NationalIdType
|The national  ID type assigned to the staff member (for example, GMC number, NMC number or  Pathology ID)
|Practitioner::Identifier::Value  (system=gmc-number)
| -
| -
|-
|IDNational
|The ODS code  of the staff member, related to the NationalIDType
|Practitioner::Identifier::Value  (system=gmc-number)
|practitioner
|gmc_code
|-
|IDSmartCard
|The smartcard  number associated with the staff member
|Practitioner::Identifier::Value  (system=<nowiki>http://tpp-uk.com/identifier/staff-smartcard-id</nowiki>)
| -
| -
|-
|PPAID
|The PPA ID of  the staff member
|Practitioner::Identifier::Value  (system=gmp-ppd-code)
| -
| -
|-
|GPLocalCode
|The GP local  code for the HA recorded in GPLocalCodeHA
|Practitioner::Identifier::Value  (system=staff-gp-local-code)
| -
| -
|-
|GmpID
|The GMP ID  associated with this staff member profile
|Practitioner::Identifier::Value  (system=gmp-ppd-code)
| -
| -
|}
==Appointments==
===Appointment Session===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|AppointmentSessionGuid
|Unique ID
|Schedule::Id*
|schedule
|id
|-
|Description
|Name of session
|Schedule::Comment
|schedule
|name
|-
|LocationGuid
|Link to Organisation  - Location  - LocationGuid
|Schedule::primarycare-location-extension::ReferenceValue  *
|schedule
|location
|-
|SessionTypeDescription
|Session type
|Schedule::Type::Text
|schedule
|type
|-
|SessionCategoryDisplayName
|Session category name
|Schedule::Comment
|
|
|
|
|-
|StartDate
|Start date
|Schedule::PlanningHorizon::Start
|schedule
|start_date
|-
|StartTime
|Start time
|Schedule::PlanningHorizon::Start
| -
| -
|-
|EndDate
|End date
|Schedule::PlanningHorizon::End
| -
| -
|-
|EndTime
|End time
|Schedule::PlanningHorizon::End
| -
| -
|-
|OrganisationGuid
|Link to Organisation  - Organisation - OrganisationGuid
|Schedule::ManagingOrganization*
|schedule
|organization_id
|-
|-
|Deleted
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|
|If true, FHIR resource is deleted
|
| -
|
| -
|-
|DateCreation
|The date and time  that the rota was created
|Schedule::primarycare-recorded-date-extension::DateValue*
| -
| -
|-
|IDProfileCreatedBy
|The unique identifier  of the staff profile who created the rota
|Schedule::primarycare-recorded-by-extension::ReferenceValue*
| -
| -
|}
 
===Appointment Session User===
 
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|SessionGuid
|Link to  Appointment - Appointment_Session - AppointmentSessionGuid
|<used to match to the  corresponding FHIR Schedule>
|appointment
|schedule_id
|-
|UserInRoleGuid
|Link to User -  UserInRoleGuid
|Actor::Reference *
|appointment
|practitioner_id
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|<if true, this “actor” is removed  from the FHIR Schedule>
| -
| -
|}
 
===Appointment Slot===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|SlotGuid  (IDAppointment)
|Unique ID
|Appointment::Id *
Slot::Id *
|appointment
|id
|-
|AppointmentStatus
|The current status  for appointment. The list of possible values is provided in a mapping table
|Appointment::Status (=Value)
|appointment
|appointment_status_concept_id
|-
|AppointmentDate
|Date of appointment
|Appointment::Start
Slot::Start
|appointment
|start_date
|-
|AppointmentStartTime
|Time of appointment
|Appointment::Start
Slot::Start
|appointment
|date_time_sent_in
|-
|PlannedDurationInMinutes
|Planned duration of  appointment in minutes
|Appointment::End
Slot::End
<number of minutes is added to start time to derive end time>
|appointment
|planned_duration
|-
|PatientGuid  (IDPatient)
|Link to  Patient_Demographics - PatientGuid / The unique identifier for the patient  record
|Appointment::Participant::Reference *
|appointment
|patient_id
|-
|SendInTime  (DatePatientArrival)
|Time patient was sent  in
|Appointment::primarycare-appointment-sent-in-extension::DateTimeValue
Appointment::Status (=Arrived)
|appointment
|date_time_sent_in
appointment_status_concept_id
|-
|LeftTime  (DatePatientSeen)
|Time patient left
|Appointment::primarycare-appointment-left-extension::DateTimeValue
Appointment::Status (=Fulfilled)
|appointment
|date_time_left
appointment_status_concept_id
|-
|DidNotAttend
|Did the patient  attend Y/N
|Appointment::Status (=NoShow)
|appointment
|appointment_status_concept_id
|-
|PatientWaitInMin
|How long the patient  waited for from their time of arrival
|Appointment::primarycare-appointment-wait-extension::DurationValue
|appointment
|patient_wait
|-
|AppointmentDelayInMin
|How long the patient  waited for from their appointment time
|Appointment::primarycare-appointment-delay-extension::DurationValue
|appointment
|patient_delay
|-
|ActualDurationInMinutes
|Actual duration of  appointment in minutes
|Appointment::MinutesDuration
|appointment
|actual_duration
|-
|OrganisationGuid
|Link to Organisation  - Organisation - OrganisationGuid
|n/a
|appointment
|organization_id
|-
|SessionGuid  (IDRota)
|Link to Appointment -  Appointment_Session - AppointmentSessionGuid
|Slot::Schedule::Reference *
|appointment
|schedule_id
|-
|DnaReasonCodeId
|Link to Coding -  CodeId
|Appointment::primarycare-appointment-dna-reason-extension::CodeableConceptValue  (code and term looked up via Coding_ClinicalCode content)
| -
| -
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|<If true, both FHIR resources are  deleted>
| -
| -
|-
|TelephoneAppointment
|Defines whether the  appointment was conducted over the phone or not
|Appointment::Type::Value
|appointment_additional
|property_id (type), text
|-
|Flag
|The name of the  appointment flag. The name is the description showing what the flag  represents
|Appointment::Comment::Text
| -
| -
|-
|IDProfileEnteredBy
|The unique identifier  of the staff profile who created this entry visit schedule
|Schedule::primarycare-recorded-by-extension::ReferenceValue*
| -
| -
|-
|DateBooked
|The date that the  visit was booked
|Schedule::primarycare-recorded-date-extension::DateValue*
Appointment::appointment-booking-date-extension::DateValue*
| -
| -
|-
|DateRequested
|The date that the  visit was marked as requested
|Schedule::PlanningHorizon::Start
Appointment::Start
Slot::Start
|appointment
|start_date
|-
|FollowUpDetails
|Defines whether a  follow up needs to be completed after this visit.
|Appointment::Comment::Text
| -
| -
|-
|DateAppointmentBooked
|The date and time  that the appointment was booked
|Appointment::appointment-booking-date-extension::DateValue*
| -
| -
|-
|DateAppointmentCancelled
|The date and time  that the appointment was cancelled
|Appointment::appointment-cancellation-date-extension::DateValue*
| -
| -
|}
 
==Care Record==
 
===Consultation===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|ConsultationGuid  (IDEvent)
|Unique ID
|Encounter::Id
|encounter
|id
|-
|PatientGuid  (IDPatient)
|Link to  Patient_Demographics - PatientGuid
|Encounter::Patient::Reference
|encounter
|patient_id
|-
|OrganisationGuid  (IDOrganisationDoneAt)
|Link to Organisation  - Organisation - OrganisationGuid
|Encounter::ServiceProvider::ReferenceValue
| -
| -
|-
|IDBranch
|The unique identifier  of the branch at which the date was entered
|Encounter::Location::ReferenceValue
|encounter
|institution_location_id
|-
|EffectiveDate  (DateEvent)
|Clinically effective  date
|Encounter::Period::Start
|encounter
|clinical_effective_date
|-
|EffectiveDatePrecision
|Date accuracy
|Encounter::Period::Start
|encounter
|date_precision_concept_id
|-
|EnteredDate  (DateEventRecorded)
|Entered date
|Encounter::primarycare-recorded-date-extension::DateValue
|encounter
|date_recorded
|-
|EnteredTime  (DateEventRecorded)
|Entered time
|Encounter::primarycare-recorded-date-extension::DateValue
|encounter
|date_recorded
|-
|ClinicianUserInRoleGuid  (IDDoneBy)
|Links to User -  UserInRoleGuid
|Encounter::Participant::ReferenceValue
|encounter
|practitioner_id
|-
|EnteredByUserInRoleGuid  (IDProfileEnteredBy)
|Links to User -  UserInRoleGuid
|Encounter::primarycare-recorded-by-extension::ReferenceValue
|encounter
|practitioner_id
|-
|AppointmentSlotGuid  (IDAppointment)
|Link to Appointment -  Appointment_Slot - SlotGuid
|Encounter::Appointment::ReferenceValue
|encounter
|appointment_id
|-
|ConsultationSourceTerm
|Source of  Consultation (derived from CodeId - Term)
|Encounter::CodeableConcept.Text
|encounter
|non_core_concept_id
|-
|ConsultationSourceCodeId
|Link to Coding -  CodeId
|Encounter::CodeableConcept.Text  (derived)
|encounter
|non_core_concept_id
|-
|ClinicalEvent
|Defines whether the  event is a clinical event or an admin event
|Encounter::CodeableConcept.Text  (derived)
|encounter
|non_core_concept_id
|-
|Complete  (EventIncomplete)
|Y/N
|Encounter::primarycare-encounter-incomplete::BooleanValue
| -
| -
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|If true, FHIR resource is deleted
| -
| -
|-
|IsConfidential
|Flag to indicate  observation is marked as confidential
|Encounter::primarycare-confidential::BooleanValue
| -
| -
|-
|ContactEventLocation
|The location of  contact
|Encounter::CodeableConcept.Text  (derived)
|encounter
|non_core_concept_id
|-
|ContactMethod
|The contact method  (for example, telephone or face to face)
|Encounter::CodeableConcept.Text  (derived)
|encounter
|non_core_concept_id
|-
|IDVisit
|The unique identifier of the visit  linked to the event.
|Encounter::Id
|encounter
|id
|}
 
===Diary Entry===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|DiaryGuid
|Unique ID
|ProcedureRequest::Id
|procedure_request
|id
|-
|PatientGuid
|Link to  Patient_Demographics - PatientGuid
|ProcedureRequest::Patient::Reference
|procedure_request
|patient_id
|-
|OrganisationGuid
|Link to Organisation  - Organisation - OrganisationGuid
|n/a
| -
| -
|-
|EffectiveDate
|Clinically effective  date
|ProcedureRequest::Scheduled:DateValue
|procedure_request
|clinical_effective_date
|-
|EffectiveDatePrecision
|Date accuracy
|ProcedureRequest::Scheduled:DateValue
|procedure_request
|date_precision_concept_id
|-
|EnteredDate
|Date entry was  created
|ProcedureRequest::OrderedOn::DateTimeValue
|procedure_request
|date_recorded
|-
|EnteredTime
|Time entry was  created
|ProcedureRequest::OrderedOn::DateTimeValue
|procedure_request
|date_recorded
|-
|ClinicianUserInRoleGuid
|Links to User -  UserInRoleGuid
|ProcedureRequest::Performer::ReferenceValue
|procedure_request
|practitioner_id
|-
|EnteredByUserInRoleGuid
|Links to User -  UserInRoleGuid
|ProcedureRequest::Orderer::ReferenceValue
|procedure_request
|practitioner_id
|-
|CodeId
|Links to Coding -  CodeId
|ProcedureRequest::CodeableConcept::Coding
|procedure_request
|non_core_concept_id
|-
|OriginalTerm
|The numeric value for  result observations
|ProcedureRequest::CodeableConcept::Text
|procedure_request
|non_core_concept_id
|-
|DurationTerm
|Duration free text
|ProcedureRequest::primarycare-procedure-request-schedule-text-extension::Text
| -
| -
|-
|LocationTypeDescription
|Location type  description
|ProcedureRequest::primarycare-procedure-request-location-extension::Text
| -
| -
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|If true, FHIR resource is deleted
| -
| -
|-
|IsConfidential
|Flag to indicate  observation is marked as confidential
|ProcedureRequest::primarycare-confidential::BooleanValue
| -
| -
|-
|IsActive
|Indicates whether the  diary entry is currently active
|ProcedureRequest::Status
|procedure_request
|status_concept_id
|-
|IsComplete
|Indicates whether the  diary entry is complete
|ProcedureRequest::Status
|procedure_request
|status_concept_id
|-
|ConsultationGuid
|Link to CareRecord -  Consultation - ConsultationGuid
|ProcedureRequest::Encounter::ReferenceValue
|procedure_request
|encounter_id
|}
 
===Observation===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|ObservationGuid  (IDEvent)
|Unique ID
|Observation::Id
|observation
|id
|-
|PatientGuid  (IDPatient)
|Link to  Patient_Demographics - PatientGuid
|Observation::Patient::Reference
|observation
|patient_id
|-
|OrganisationGuid  (IDOrganisationDoneAt)
|Link to Organisation  - Organisation - OrganisationGuid
|n/a
| -
| -
|-
|EffectiveDate  (DateEvent)
|Clinically effective  date
|Observation::EffectiveDate:DateTimeValue
|observation
|clinical_effective_date
|-
|EffectiveDatePrecision
|Date accuracy
|Observation::EffectiveDate:DateTimeValue
|observation
|date_precision_concept_id
|-
|EnteredDate
|Date entry was  created
|Observation::primarycare-recorded-date-extension::DateTimeValue
|observation
|date_recorded
|-
|EnteredTime
|Time entry was  created
|Observation::primarycare-recorded-date-extension::DateTimeValue
|observation
|date_recorded
|-
|ClinicianUserInRoleGuid  (IDDoneBy)
|Links to User -  UserInRoleGuid
|Observation::Performer::ReferenceValue
|observation
|practitioner_id
|-
|EnteredByUserInRoleGuid  (IDProfileEnteredBy)
|Links to User -  UserInRoleGuid
|Observation::primarycare-recorded-by-extension::ReferenceValue
| -
| -
|-
|ParentObservationGuid
|If this observation  has a parent code the link to the ParentObservationGuid is provided here
|Observation::parent-resource::ReferenceValue
|observation
|parent_observation_id
|-
|ProblemGuid
|Link to CareRecord -  Problem - ProblemGuid
|Condition::primarycare-condition-partofproblemepisode-extension::ReferenceValue
| -
| -
|-
|ConsultationGuid
|Link to CareRecord -  Consultation - ConsultationGuid
|Observation::Encounter::ReferenceValue
|observation
|encounter_id
|-
|CodeId
|Links to Coding -  CodeId
|Observation::CodeableConcept::Coding
|observation
|non_core_concept_id
|-
|CTV3Code
|The CTV3 Read code  for this entry
|Observation::CodeableConcept::Coding
|observation
|non_core_concept_id
|-
|CTV3Text
|The textual  description of the CTV3 Read code from the code file
|Observation::CodeableConcept::Coding
|observation
|non_core_concept_id
|-
|SNOMEDCode
|The SNOMED concept ID  for this entry
 
|Observation::CodeableConcept::Coding
|observation
|non_core_concept_id
|-
|SNOMEDText
|The textual  description for the SNOMED concept ID
|Observation::CodeableConcept::Coding
|observation
|non_core_concept_id
|-
|IsNumeric
|Whether this coded  entry was recorded as a numeric
| -
| -
| -
|-
|Value
|The numeric value for  result observations
|Observation::Quantity::Value
|observation
|result_value
|-
|NumericUnit
|Unit
|Observation::Quantity::Unit
|observation
|result_value_units
|-
|ObservationType  (Episode Type)
|Type of observation  (allergy, immunisation, etc)
|n/a
| -
| -
|-
|NumericRangeLow
|Low Range
|Observation::ReferenceRange::Low
|observation_additional
|property_id,  json_value
|-
|NumericRangeHigh
|High Range
|Observation::ReferenceRange::High
|observation_additional
|property_id,  json_value
|-
|DocumentGuid
|Unique ID for  associated attachment
|Observation::primarycare-external-document-extension::Identifier
| -
| -
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|If true, FHIR resource is deleted
| -
| -
|-
|IsConfidential
|Flag to indicate  observation is marked as confidential
|Observation::primarycare-confidential::BooleanValue
| -
| -
|}
 
===Referral===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|PatientGuid
|Link to  Patient_Demographics - PatientGuid
|ReferralRequest::Patient::ReferenceValue
|referral_request
|patient_id
|-
|OrganisationGuid
|Link to Organisation  - Organisation - OrganisationGuid
|ReferralRequest::Requester::ReferenceValue  (Organization)
|referral_request
|requester_organization_id
|-
|ObservationGuid
|Unique ID
|ReferralRequest::Id
|referral_request
|id
|-
|ReferralTargetOrganisationGuid
|Link to Organisation  - Organisation - OrganisationGuid
|ReferralRequest::Recipient::ReferenceValue
|referral_request
|recipient_organization_id
|-
|ReferralUrgency
|Urgency of referral
|ReferralRequest::CodeableConcept::Coding  (Priority)
|referral_request
|referral_request_priority_concept_id
|-
|ReferralServiceType  (ServiceOffered)
|Service type
|ReferralRequest::CodeableConcept::Coding  (Type)
|referral_request
|referral_request_type_concept_id
|-
|ReferralMode
|Mode of referral
|ReferralRequest::primarycare-referral-request-send-mode-extension::Value
|referral_request
|mode
|-
|Reason
|The reason for  referral
|ReferralRequest::CodeableConcept::Text  (Type)
| -
| -
|-
|IDProfileReferrer
|Links to User -  UserInRoleGuid
|ReferralRequest::Requester::ReferenceValue  (Practitioner)
|referral_request
|practitioner_id
|-
|DateEventRecorded
|Date and time that  the event was entered on to the system
|ReferralRequest::primarycare-recorded-date-extension::DateValue
|referral_request
|date_recorded
|-
|DateEvent
|Date and time that  the event occurred
|ReferralRequest::Date::DateValue
|referral_request
|clinical_effective_date
|-
|IDProfileEnteredBy
|Links to User -  UserInRoleGuid
|ReferralRequest::primarycare-recorded-by-extension::ReferenceValue
| -
| -
|-
|IDDoneBy
|Links to User -  UserInRoleGuid
|ReferralRequest::Requester::ReferenceValue
|referral_request
|practitioner_id
|-
|PrimaryDiagnosis
|CTV3 Read code  selected as the primary diagnosis against the referral
|ReferralRequest::CodeableConcept::Coding  (Service)
|referral_request
|non_core_concept_id
|-
|SNOMEDPrimaryDiagnosis
|SNOMED code selected  as the primary diagnosis against the referral
|ReferralRequest::CodeableConcept::Coding  (Service)
|referral_request
|non_core_concept_id
|-
|RecipientID
|The national ID of  the recipient of the referral (receiving clinician)
|ReferralRequest::referral-request-recipient-free-text-extension::TextValue
| -
| -
|-
|RecipientIDType
|The type of national  ID of the referrer (for example GMC)
|ReferralRequest::referral-request-recipient-free-text-extension::TextValue
| -
| -
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|If true, FHIR resource is deleted
| -
| -
|}
|}


== Registration ==
===Problem===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|PatientGuid
|Link to  Patient_Demographics - PatientGuid
|Condition::Patient::ReferenceValue
|observation
|patient_id
|-
|OrganisationGuid
|Link to Organisation  - Organisation - OrganisationGuid
| -
| -
| -
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|If true, FHIR resource is deleted
| -
| -
|-
|EndDate
|Problem end date
|Condition::AbatementDate::DateValue
|observation
|problem_end_date
|-
|EndDatePrecision
|Date accuracy
|Condition::AbatementDate::DateValue
| -
| -
|-
|ExpectedDuration
|Expected duration of  problem
|Condition::primarycare-problem-expectedduration-extension::Value
| -
| -
|-
|LastReviewDate
|Date Problem last  reviewd
|Condition::primarycare-problem-lastreviewed-extension::DateValue
| -
| -
|-
|LastReviewDatePrecision
|Date accuracy
|Condition::primarycare-problem-lastreviewed-extension::date::DateValue
| -
| -
|-
|LastReviewUserInRoleGuid
|Links to User -  UserInRoleGuid
|Condition::primarycare-problem-lastreviewed-extension::performer::ReferenceValue
| -
| -
|-
|ProblemStatusDescription
|Status of the problem
|Condition::AbatementDate::BooleanValue  (Past Problem)
| -
| -
|-
|SignificanceDescription
|Problem significance
|Condition::primarycare-problem-significance-extension::Value
|observation_additional
|property_id, value_id
|}


===Flag===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|DateAdded  (DateStart)
|The date and  time information event was added / date and time note started
|Flag::Period::Start::DateValue
|flag
|effective_date
|-
|IDProfileEnteredBy
|Links to User -  UserInRoleGuid
|Flag::Author::ReferenceValue
| -
| -
|-
|ProtectionPlan
|Defines if the  patient is on a protection plan for this entry of information
|Flag::Status::Value
|flag
|flag_text
|-
|DateRemoved  (DateExpired)
|The date and time the  information was removed / date and time note expired
|Flag::Period::End::DateValue
| -
| -
|-
|ReasonForPlan  (Note)
|The reason the  patient was added to a protection plan / text of note
|Flag::CodeableConcept::Text
|flag
|flag_text
|-
|IDPatient
|Link to  Patient_Demographics - PatientGuid
|Flag::Subject::ReferenceValue
|flag
|patient_id
|-
|Type
|The type of special  note added (for example, special note, safe haven, frequent caller)
|n/a
|flag
|flag_text
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|If true, FHIR resource is deleted
| -
| -
|}


==Coding==
A reference file containing the coded entries used by the clinical system is to be provided as a separate file within the extract.
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Field Name
Line 556: Line 1,732:
! scope="col" width="15%" |Field
! scope="col" width="15%" |Field
|-
|-
|
|CodeId
|
|Unique ID
|
|n/a
|
|n/a
|
|n/a
|-
|Term
|Code term
|n/a
|n/a
|n/a
|-
|Type
|SNOMED, Read, Ctv3,  DM&D ID, Local code, etc.
 
|n/a
|n/a
|n/a
|-
|ParentCodeID
|Unique ID
|n/a
|n/a
|n/a
|}
|}


== User ==
==Prescribing==


== Appointments ==
===Drug Record===
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|DrugRecordGuid
|Unique ID
|MedicationStatement::Id *
|medication_statement
|id
|-
|PatientGuid
|Link to  Patient_Demographics - PatientGuid
|MedicationStatement::Patient::Reference  *
|medication_statement
|patient_id
|-
|OrganisationGuid
|Link to Organisation  - Organisation - OrganisationGuid
|n/a
| -
| -
|-
|EffectiveDate
|Clinically effective  date
|MedicationStatement::DateAsserted
|medication_statement
|clinical_effective_date
|-
|EffectiveDatePrecision
|Date accuracy
|MedicationStatement::DateAsserted
|medication_statement
|date_precision_concept_id
|-
|EnteredDate
|Date entered
|MedicationStatement::primarycare-recorded-date-extension::DateTimeValue
|medication_statement
|date_recorded
|-
|EnteredTime
|Time entry was  created
|MedicationStatement::primarycare-recorded-date-extension::DateTimeValue
|medication_statement
|date_recorded
|-
|ClinicianUserInRoleGuid  (IDDoneBy)
|Link to User -  UserInRoleGuid
|MedicationStatement::InformationSource::Reference  *
|medication_statement
|practitioner_id
|-
|EnteredByUserInRoleGuid
|Link to User -  UserInRoleGuid
|MedicationStatement::primarycare-recorded-by-extension::ReferenceValue  *
|medication_statement
|practitioner_id
|-
|CodeId  (IDMultiLexDMD)
|Link to Coding -  CodeId
|MedicationStatement::CodeableConcept::Coding
|medication_statement
|core_concept_id
|-
|Dosage
|Dosage
|MedicationStatement::Dosage::Text
|medication_statement
|dose
|-
|Quantity
|Quantity
|MedicationStatement::primarycare-medication-authorisation-quantity-extension::Quantity::Value
|medication_statement
|quantity_value
|-
|QuantityUnit
|Unit
|MedicationStatement::primarycare-medication-authorisation-quantity-extension::Quantity::Unit
|medication_statement
|quantity_unit
|-
|ProblemObservationGuid
|Link to Care Record -  Observation - ProblemGuid
|MedicationStatement::Reason::Reference  *
(target Condition resource is also updated with a reference back to this  one)
| -
| -
|-
|PrescriptionType
|Type of prescription
|MedicationStatement::primarycare-medication-authorisation-type-extension::CodeableConceptValue  ***
|medication_statement
|authorisation_type_concept_id
|-
|IsActive
|Is this still active
|MedicationStatement::Status
|medication_statement
|is_active
|-
|CancellationDate  (DateMedicationEnd)
|Date of Cancellation
|MedicationStatement::primarycare-medication-authorisation-cancellation-extension::DateValue
|medication_statement
|cancellation_date
|-
|NumberOfIssues
|No. of times drug has  been issued on current authorisation
|MedicationStatement::primarycare-medication-authorisation-numberofrepeatsissued-extension::IntValue
| -
| -
|-
|NumberOfIssuesAuthorised
|No. of issues  authorised
|MedicationStatement::primarycare-medication-authorisation-numberofrepeatsallowed-extension::IntValue
| -
| -
|-
|IsConfidential
|Flag to indicate  observation is marked as confidential
|MedicationStatement::primarycare-confidential::ValueBoolean  (extension only created if value is true)
| -
| -
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|<If true,  FHIR resource is deleted>
| -
| -
|-
|NameOfMedication
|The name of the  medication.


== Care Record ==
|MedicationStatement::CodeableConcept::Coding::Text
|medication_statement
|core_concept_id
|-
|IsOtherMedication
|Defines whether the  medication has been recorded as an 'other' medication instead of an acute
|n/a
| -
| -
|-
|IsDentalMedication
|Defines whether the  medication has been recorded as 'dental' medication instead of an acute
|n/a
| -
| -
|-
|IsHospitalMedication
|Defines whether the  medication has been recorded as 'hospital' medication instead of an acute
|n/a
| -
| -
|-
|IDRepeatTemplate
|The unique identifier  of the Repeat Template the drug was prescribed from
|MedicationOrder::primarycare-medication-order-authorisation-extension::ValueReference  *
|medication_order
|medication_statement_id
|}
 
===Issue Record===


== Coding ==
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:70%;"
! colspan="2" style="color:#90A4AE" |'''Publisher'''
!style="color:#90A4AE"|DDS Core
! colspan="2" style="color:#90A4AE"|Compass V2
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="15%" |Field Name
! scope="col" width="15%" |Data/Coding Type
! scope="col" width="25%" |FHIR
! scope="col" width="15%" |Table
! scope="col" width="15%" |Field
|-
|IssueRecordGuid
|Unique ID
|MedicationOrder::Id *
|medication_order
|id
|-
|PatientGuid
|Link to  Patient_Demographics - PatientGuid
|MedicationOrder::Patient::Reference  *
|medication_order
|patient_id
|-
|OrganisationGuid
|Link to Organisation  - Organisation - OrganisationGuid
| -
|medication_order
|organization_id
|-
|DrugRecordGuid
|Link to Prescribing -  DrugRecord - DrugRecordGuid
|MedicationOrder::primarycare-medication-order-authorisation-extension::ValueReference  *
|medication_order
|medication_statement_id
|-
|EffectiveDate
|The date and time  that the event occurred
|MedicationOrder::DateWritten
(this date is also used to populate the  primarycare-medication-authorisation-firstissuedate-extension::ValueDate and  primarycare-medication-authorisation-mostrecentissuedate-extension::ValueDate  extensions on the FHIR MedicationStatement)
|medication_order
|clinical_effective_date
|-
|EffectiveDatePrecision
|Date accuracy
|MedicationOrder::DateWritten
(this date is also used to populate the  primarycare-medication-authorisation-firstissuedate-extension::ValueDate and  primarycare-medication-authorisation-mostrecentissuedate-extension::ValueDate  extensions on the FHIR MedicationStatement)
|medication_order
|date_precision_concept_id
|-
|EnteredDate
|Entered date
|MedicationOrder::primarycare-recorded-date-extension::DateTimeValue
|medication_order
|date_recorded
|-
|EnteredTime
|Time entry was  created
|MedicationOrder::primarycare-recorded-date-extension::DateTimeValue
|medication_order
|date_recorded
|-
|ClinicianUserInRoleGuid  (IDDoneBy)
|Link to User -  UserInRoleGuid
|MedicationOrder::Prescriber::Reference  *
|medication_order
|practitioner_id
|-
|EnteredByUserInRoleGuid
|Link to User -  UserInRoleGuid
|MedicationOrder::primarycare-recorded-by-extension::ReferenceValue  *
|medication_order
|practitioner_id
|-
|CodeId  (IDMultiLexDMD)
|Link to Prescribing -  Drug_Code - CodeId
|MedicationStatement::CodeableConcept::Coding
|medication_order
|core_concept_id
|-
|Dosage
|Dosage
|MedicationOrder::Dosage::Text
|medication_order
|dose
|-
|Quantity
|Quantity
|MedicationOrder::DispenseRequest::Quantity::Value
|medication_order
|quantity_value
|-
|QuantityUnit
|Unit
|MedicationOrder::DispenseRequest::Quantity::Unit
|medication_order
|quantity_unit
|-
|ProblemObservationGuid
|Link to Care Record -  Observation - ProblemGuid
|MedicationOrder::Reason::Reference  *
(target Condition resource is also updated with a reference back to this  one)
| -
| -
|-
|CourseDurationInDays
|Number of days the  course was due to last (where known)
|MedicationOrder::DispenseRequest.ExpectedSupplyDuration.Value
|medication_order
|duration_days
|-
|EstimatedNhsCost
|Estimated NHS cost
|MedicationOrder::primarycare-medication-order-estimatednhscost-extension::DecimalValue
|medication_order
|estimated_cost
|-
|IsConfidential
|Flag to indicate  observation is marked as confidential
|MedicationOrder::primarycare-confidential::ValueBoolean  (extension only created if value is true)
| -
| -
|-
|Deleted
|Indicates whether the  record has been deleted (True/Fales , 0/1)
|<If true,  FHIR resource is deleted>
| -
| -
|-
|NameOfMedication
|The name of the  medication repeat template.


== Prescribing ==
|MedicationOrder::CodeableConcept::Coding::Text
| -
| -
|}

Latest revision as of 10:59, 3 August 2023

To see the latest Compass V2 schema, please see Discovery Remote Subscriber Database Familiarisation#Data_Mapping

Organisation

Organisation

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
OrganisationGuid Unique ID Organization::Id* organization id
CDB (Local Identifier) Customer number Organization::Identifier::Value (use=secondary, system=cdb-number) - -
OrganisationName Name of organisation Organization::name organization Name
ODSCode ODS code Organization::Identifier::Value (use=official, system=ods-organization-code) organization ods_code
ParentOrganisationGuid Links to Organisation - Organisation - OrganisationGuid Organization::PartOf::Reference * organization parent_organization_id
CCGOrganisationGuid Links to Organisation - Organisation - OrganisationGuid Organization::PartOf::Reference * - -
OrganisationType Type of organisation Organization::Type organization type_desc
OpenDate Date organisation opened Organization::primarycare-activeperiod-extension::ValuePeriod::Start - -
CloseDate Date organisation closed Organization::primarycare-activeperiod-extension::ValuePeriod::End - -
MainLocationGuid Link to Organisation - Location - LocationGuid Organization::primarycare-mainlocation-extension::ValueReference* - -

Location

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
LocationGuid Unique ID Location::Id* location id
LocationName Location name Location::Name location name
LocationTypeDescription Type of location Location::Type::Text location type_desc
ParentLocationGuid Parent location Location::PartOf::Reference * location managing_organization_id
OpenDate Open Date Location::primarycare-activeperiod-extension::ValuePeriod::Start - -
CloseDate Close Date Location::primarycare-activeperiod-extension::ValuePeriod::End - -
MainContactName Main contact name Location::primarycare-location-main-contact-extension::String - -
FaxNumber Fax number Location::contactPoint::fax (use=work, system=fax) - -
EmailAddress Email adress Location::contactPoint::email (use=work, system=email) - -
PhoneNumber Phone number Location::contactPoint::phone  (use=work, system=phone) - -
HouseNameFlatNumber Address name/flat number Location::Address::Line - -
NumberAndStreet Address street Location::Address::Line - -
Village Address village Location::Address::Line - -
Town Address town Location::Address::City - -
County Address county Location::Address::District - -
Postcode Postcode Location::Address::PostalCode location Postcode

Organisation Location (used to associate a location with an organisation)

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
OrganisationGuid Unique ID ManagingOrganization* - -
LocationGuid Link to Organisation - Location -  LocationGuid <used to match to the corresponding FHIR Location> - -
IsMainLocation Flag to indicate if this is the main location <used to order the ManagingOrganization references> - -

Patient Demographics

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
PatientGuid Unique patient ID Patient::Id* EpisodeOfCare::Id* patient id
OrganisationGuid Links to Organisation - Organisation - OrganisationGuid EpisodeOfCare::ManagingOrganization::Reference * patient organization_id
NHSNumber NHS number Patient::Identifier::Value (use=official, system=nhs-number) patient nhs_number
PatientNumber Patient number Patient::Identifier::Value (use=secondary, system=patient-number) patient person_id
PatientTypeDescription Patient type EpisodeOfCare:: primarycare-patient-registration-type-extension::ValueCodeableConcept*** episode_of_care registration_type_concept_id
DummyType Is a dummy patient Patient::patient-is-test-patient-extension::ValueBoolean (extension is only created if value is true) - -
Title Title Patient::Name::Prefix (use=official) patient title
GivenName Forename Patient::Name::Given patient first_names
MiddleNames Middle name Patient::Name::Given patient first_names
Surname Surname Patient::Name::Family patient last_name
DateOfBirth Date of birth Patient::BirthDate patient date_of_birth
DateOfDeath Date of death Patient::Deceased patient date_of_death
Sex (Gender) Sex of patient / Patients gender Patient::Gender patient gender_concept_id
HouseNameFlatNumber House name, flat no Patient::Address::Line patient_address address_line_1
NumberAndStreet Number and street Patient::Address::Line patient_address address_line_2
Village Village Patient::Address::Line patient_address address_line_3
Town Town Patient::Address::City patient_address city
County County Patient::Address::District patient_address address_line_4
Postcode Postcode Patient::Address::PostalCode patient_address postcode
AddressType Home, temporary, correspondence only, no fixed abode Patient::Address::Use (temp, home,old) patient_address use_concept_id
DateEvent The date the patient registered at the address Patient::Address::Period.start patient_address Start_date
DateTo The date the patient left the address Patient::Address::Period.end patient_address end_date
EmailAddress Email address Patient::contactPoint::email (use=home, system=email) patient_contact type_concept_id - value
HomePhone Home phone Patient::contactPoint::phone (use=home, system=phone) patient_contact type_concept_id - value
MobilePhone Mobile phone Patient::contactPoint::phone (use=mobile, system=phone) patient_contact type_concept_id - value
ContactType Home, Mobile, Work Patient::Telecom::Value (use=home,mobile, system=phone,email) patient_contact type_concept_id
DateEvent The date the patient registered the contact Patient::Address::Period.start patient_contact Start_date
BirthPlace The location where the patient was born n/a - -
SpeaksEnglish Defines if the patient speaks English Patient::patient-speaks-english-extension::ValueBoolean (extension is only created if value is true) - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) - - -

Patient Relationship (if available)

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
RelationshipType The relationship type (for example husband or key worker) Patient::contact::codeableConcept::text - -
DateStarted The date and time that the relationship started Patient::contact::Period.start - -
DateEnded The date and time that the relationship was ended Patient::contact::Period.end - -
NextOfKin Defines if this is a next of kin relationship Patient::patient-contact-is-next-of-kin::ValueBoolean (extension is only created if value is true) - -
CaresForPatient Defines whether the relation cares for the patient Patient::patient-contact-is-carer::ValueBoolean (extension is only created if value is true) - -
PrincipalCarerForPatient Defines whether the relation is the principal carer for the patient Patient::patient-contact-is-carer::ValueBoolean (extension is only created if value is true) - -
RelationshipWithName The name of the person the relationship is with Patient::contact::name::text - -
RelationshipWithDateOfBirth The date of birth of the person the relationship is with n/a - -
RelationshipWithHouseName The house name part of the address of the person the relationship is with Patient::contact::Address::Line - -
RelationshipWithHouseNumber The house number part of the address of the person the relationship is with Patient::contact::Address::Line - -
RelationshipWithRoad The road part of the address of the person the relationship is with Patient::contact::Address::Line - -
RelationshipWithLocality The locality part of the address of the person the relationship is with Patient::contact::Address::Line - -
RelationshipWithPostTown The post town part of the address of the person the relationship is with Patient::contact::Address::City - -
RelationshipWithCounty The county part of the address of the person the relationship is with Patient::contact::Address::District - -
RelationshipWithPostCode The post code of the person the relationship is with Patient::contact::Address::PostalCode - -
RelationshipWithTelephone The telephone number of the person the relationship is with Patient::contact::contactPoint::phone (use=home, system=phone) - -
RelationshipWithWorkTelephone The work telephone number of the person the relationship is with Patient::contact::contactPoint::phone (use=work, system=phone) - -
RelationshipWithMobileTelephone The mobile telephone number of the person the relationship is with Patient::contact::contactPoint::phone (use=mobile, system=phone) - -
RelationshipWithFax The fax number of the person the relationship is with Patient::contact::contactPoint::fax (system=fax) - -
RelationshipWithEmailAddress The email address of the person the relationship is with Patient::contact::contactPoint::email (system=email) - -
IDPatient Links to Patient_Demographics - PatientGuid Patient::Id* - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) - - -

Registration

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
PatientGuid Unique patient ID Patient::Id*

EpisodeOfCare::Id*

episode_of_care

registration_status_history

patient_id

patient_id

OrganisationGuid Links to Organisation - Organisation - OrganisationGuid EpisodeOfCare::ManagingOrganization::Reference * episode_of_care

registration_status_history

organization_id

organization_id

DateOfRegistration Date of registration EpisodeOfCare::Period::Start episode_of_care

registration_status_history

date_registered

start_date

DateofDeactivation Date that the patient's registration became inactive EpisodeOfCare::Period::End episode_of_care

registration_status_history

date_registered_end

end_date

RegistrationStatus The patient's registration status. EpisodeOfCare::primarycare-patient-registration-type-extension::ValueCodeableConcept*** episode_of_care registration_type_concept_id
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) <If true, all FHIR resources for this patient are deleted> - -
ExternalUsualGPGuid Unique ID for External Usual GP Patient::CareProvider::Reference * - -
ExternalUsualGPOrganisation Link to Organisation - Organisation - OrganisationGuid EpisodeOfCare ::ManagingOrganization::Reference * patient registered_practice_organization_id
SpineMatched Defines if the patients NHS number has been matched on the Spine Patient::primarycare-nhs-number-verification-status-extension::Value (NHS Verification Status) - -

User

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
UserInRoleGuid (IDStaffMember) Unique ID Practitioner::Id* practitioner id
OrganisationGuid Link to Organisation - Organisation - OrganisationGuid Practitioner::Role::ManagingOrganisation::Reference * practitioner organization_id
Title Title Practitioner::Name::Prefix practitioner name
GivenName Forename Practitioner::Name::Given practitioner name
Surname Surname Practitioner::Name::Family practitioner name
JobCategoryCode Job category code Practitioner::Role::Role::Code practitioner role_code
JobCategoryName (StaffRole) Job category name Practitioner::Role::Role::Display practitioner role_desc
ContractStartDate (DateEmploymentStart) Date contract started / The date the staff member started Practitioner::Role::Period::Start - -
ContractEndDate (DateEmploymentEnd) Date contract ended / The date the staff member was archived Practitioner::Role::Period::End - -
NationalIdType The national ID type assigned to the staff member (for example, GMC number, NMC number or Pathology ID) Practitioner::Identifier::Value (system=gmc-number) - -
IDNational The ODS code of the staff member, related to the NationalIDType Practitioner::Identifier::Value (system=gmc-number) practitioner gmc_code
IDSmartCard The smartcard number associated with the staff member Practitioner::Identifier::Value (system=http://tpp-uk.com/identifier/staff-smartcard-id) - -
PPAID The PPA ID of the staff member Practitioner::Identifier::Value (system=gmp-ppd-code) - -
GPLocalCode The GP local code for the HA recorded in GPLocalCodeHA Practitioner::Identifier::Value (system=staff-gp-local-code) - -
GmpID The GMP ID associated with this staff member profile Practitioner::Identifier::Value (system=gmp-ppd-code) - -

Appointments

Appointment Session

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
AppointmentSessionGuid Unique ID Schedule::Id* schedule id
Description Name of session Schedule::Comment schedule name
LocationGuid Link to Organisation - Location  - LocationGuid Schedule::primarycare-location-extension::ReferenceValue * schedule location
SessionTypeDescription Session type Schedule::Type::Text schedule type
SessionCategoryDisplayName Session category name Schedule::Comment
StartDate Start date Schedule::PlanningHorizon::Start schedule start_date
StartTime Start time Schedule::PlanningHorizon::Start - -
EndDate End date Schedule::PlanningHorizon::End - -
EndTime End time Schedule::PlanningHorizon::End - -
OrganisationGuid Link to Organisation - Organisation - OrganisationGuid Schedule::ManagingOrganization* schedule organization_id
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) If true, FHIR resource is deleted - -
DateCreation The date and time that the rota was created Schedule::primarycare-recorded-date-extension::DateValue* - -
IDProfileCreatedBy The unique identifier of the staff profile who created the rota Schedule::primarycare-recorded-by-extension::ReferenceValue* - -

Appointment Session User

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
SessionGuid Link to Appointment - Appointment_Session - AppointmentSessionGuid <used to match to the corresponding FHIR Schedule> appointment schedule_id
UserInRoleGuid Link to User - UserInRoleGuid Actor::Reference * appointment practitioner_id
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) <if true, this “actor” is removed from the FHIR Schedule> - -

Appointment Slot

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
SlotGuid (IDAppointment) Unique ID Appointment::Id *

Slot::Id *

appointment id
AppointmentStatus The current status for appointment. The list of possible values is provided in a mapping table Appointment::Status (=Value) appointment appointment_status_concept_id
AppointmentDate Date of appointment Appointment::Start

Slot::Start

appointment start_date
AppointmentStartTime Time of appointment Appointment::Start

Slot::Start

appointment date_time_sent_in
PlannedDurationInMinutes Planned duration of appointment in minutes Appointment::End

Slot::End <number of minutes is added to start time to derive end time>

appointment planned_duration
PatientGuid (IDPatient) Link to Patient_Demographics - PatientGuid / The unique identifier for the patient record Appointment::Participant::Reference * appointment patient_id
SendInTime (DatePatientArrival) Time patient was sent in Appointment::primarycare-appointment-sent-in-extension::DateTimeValue

Appointment::Status (=Arrived)

appointment date_time_sent_in

appointment_status_concept_id

LeftTime (DatePatientSeen) Time patient left Appointment::primarycare-appointment-left-extension::DateTimeValue

Appointment::Status (=Fulfilled)

appointment date_time_left

appointment_status_concept_id

DidNotAttend Did the patient attend Y/N Appointment::Status (=NoShow) appointment appointment_status_concept_id
PatientWaitInMin How long the patient waited for from their time of arrival Appointment::primarycare-appointment-wait-extension::DurationValue appointment patient_wait
AppointmentDelayInMin How long the patient waited for from their appointment time Appointment::primarycare-appointment-delay-extension::DurationValue appointment patient_delay
ActualDurationInMinutes Actual duration of appointment in minutes Appointment::MinutesDuration appointment actual_duration
OrganisationGuid Link to Organisation - Organisation - OrganisationGuid n/a appointment organization_id
SessionGuid (IDRota) Link to Appointment - Appointment_Session - AppointmentSessionGuid Slot::Schedule::Reference * appointment schedule_id
DnaReasonCodeId Link to Coding - CodeId Appointment::primarycare-appointment-dna-reason-extension::CodeableConceptValue (code and term looked up via Coding_ClinicalCode content) - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) <If true, both FHIR resources are deleted> - -
TelephoneAppointment Defines whether the appointment was conducted over the phone or not Appointment::Type::Value appointment_additional property_id (type), text
Flag The name of the appointment flag. The name is the description showing what the flag represents Appointment::Comment::Text - -
IDProfileEnteredBy The unique identifier of the staff profile who created this entry visit schedule Schedule::primarycare-recorded-by-extension::ReferenceValue* - -
DateBooked The date that the visit was booked Schedule::primarycare-recorded-date-extension::DateValue*

Appointment::appointment-booking-date-extension::DateValue*

- -
DateRequested The date that the visit was marked as requested Schedule::PlanningHorizon::Start

Appointment::Start Slot::Start

appointment start_date
FollowUpDetails Defines whether a follow up needs to be completed after this visit. Appointment::Comment::Text - -
DateAppointmentBooked The date and time that the appointment was booked Appointment::appointment-booking-date-extension::DateValue* - -
DateAppointmentCancelled The date and time that the appointment was cancelled Appointment::appointment-cancellation-date-extension::DateValue* - -

Care Record

Consultation

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
ConsultationGuid (IDEvent) Unique ID Encounter::Id encounter id
PatientGuid (IDPatient) Link to Patient_Demographics - PatientGuid Encounter::Patient::Reference encounter patient_id
OrganisationGuid (IDOrganisationDoneAt) Link to Organisation - Organisation - OrganisationGuid Encounter::ServiceProvider::ReferenceValue - -
IDBranch The unique identifier of the branch at which the date was entered Encounter::Location::ReferenceValue encounter institution_location_id
EffectiveDate (DateEvent) Clinically effective date Encounter::Period::Start encounter clinical_effective_date
EffectiveDatePrecision Date accuracy Encounter::Period::Start encounter date_precision_concept_id
EnteredDate (DateEventRecorded) Entered date Encounter::primarycare-recorded-date-extension::DateValue encounter date_recorded
EnteredTime (DateEventRecorded) Entered time Encounter::primarycare-recorded-date-extension::DateValue encounter date_recorded
ClinicianUserInRoleGuid (IDDoneBy) Links to User - UserInRoleGuid Encounter::Participant::ReferenceValue encounter practitioner_id
EnteredByUserInRoleGuid (IDProfileEnteredBy) Links to User - UserInRoleGuid Encounter::primarycare-recorded-by-extension::ReferenceValue encounter practitioner_id
AppointmentSlotGuid (IDAppointment) Link to Appointment - Appointment_Slot - SlotGuid Encounter::Appointment::ReferenceValue encounter appointment_id
ConsultationSourceTerm Source of Consultation (derived from CodeId - Term) Encounter::CodeableConcept.Text encounter non_core_concept_id
ConsultationSourceCodeId Link to Coding - CodeId Encounter::CodeableConcept.Text (derived) encounter non_core_concept_id
ClinicalEvent Defines whether the event is a clinical event or an admin event Encounter::CodeableConcept.Text (derived) encounter non_core_concept_id
Complete (EventIncomplete) Y/N Encounter::primarycare-encounter-incomplete::BooleanValue - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) If true, FHIR resource is deleted - -
IsConfidential Flag to indicate observation is marked as confidential Encounter::primarycare-confidential::BooleanValue - -
ContactEventLocation The location of contact Encounter::CodeableConcept.Text (derived) encounter non_core_concept_id
ContactMethod The contact method (for example, telephone or face to face) Encounter::CodeableConcept.Text (derived) encounter non_core_concept_id
IDVisit The unique identifier of the visit linked to the event. Encounter::Id encounter id

Diary Entry

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
DiaryGuid Unique ID ProcedureRequest::Id procedure_request id
PatientGuid Link to Patient_Demographics - PatientGuid ProcedureRequest::Patient::Reference procedure_request patient_id
OrganisationGuid Link to Organisation - Organisation - OrganisationGuid n/a - -
EffectiveDate Clinically effective date ProcedureRequest::Scheduled:DateValue procedure_request clinical_effective_date
EffectiveDatePrecision Date accuracy ProcedureRequest::Scheduled:DateValue procedure_request date_precision_concept_id
EnteredDate Date entry was created ProcedureRequest::OrderedOn::DateTimeValue procedure_request date_recorded
EnteredTime Time entry was created ProcedureRequest::OrderedOn::DateTimeValue procedure_request date_recorded
ClinicianUserInRoleGuid Links to User - UserInRoleGuid ProcedureRequest::Performer::ReferenceValue procedure_request practitioner_id
EnteredByUserInRoleGuid Links to User - UserInRoleGuid ProcedureRequest::Orderer::ReferenceValue procedure_request practitioner_id
CodeId Links to Coding - CodeId ProcedureRequest::CodeableConcept::Coding procedure_request non_core_concept_id
OriginalTerm The numeric value for result observations ProcedureRequest::CodeableConcept::Text procedure_request non_core_concept_id
DurationTerm Duration free text ProcedureRequest::primarycare-procedure-request-schedule-text-extension::Text - -
LocationTypeDescription Location type description ProcedureRequest::primarycare-procedure-request-location-extension::Text - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) If true, FHIR resource is deleted - -
IsConfidential Flag to indicate observation is marked as confidential ProcedureRequest::primarycare-confidential::BooleanValue - -
IsActive Indicates whether the diary entry is currently active ProcedureRequest::Status procedure_request status_concept_id
IsComplete Indicates whether the diary entry is complete ProcedureRequest::Status procedure_request status_concept_id
ConsultationGuid Link to CareRecord - Consultation - ConsultationGuid ProcedureRequest::Encounter::ReferenceValue procedure_request encounter_id

Observation

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
ObservationGuid (IDEvent) Unique ID Observation::Id observation id
PatientGuid (IDPatient) Link to Patient_Demographics - PatientGuid Observation::Patient::Reference observation patient_id
OrganisationGuid (IDOrganisationDoneAt) Link to Organisation - Organisation - OrganisationGuid n/a - -
EffectiveDate (DateEvent) Clinically effective date Observation::EffectiveDate:DateTimeValue observation clinical_effective_date
EffectiveDatePrecision Date accuracy Observation::EffectiveDate:DateTimeValue observation date_precision_concept_id
EnteredDate Date entry was created Observation::primarycare-recorded-date-extension::DateTimeValue observation date_recorded
EnteredTime Time entry was created Observation::primarycare-recorded-date-extension::DateTimeValue observation date_recorded
ClinicianUserInRoleGuid (IDDoneBy) Links to User - UserInRoleGuid Observation::Performer::ReferenceValue observation practitioner_id
EnteredByUserInRoleGuid (IDProfileEnteredBy) Links to User - UserInRoleGuid Observation::primarycare-recorded-by-extension::ReferenceValue - -
ParentObservationGuid If this observation has a parent code the link to the ParentObservationGuid is provided here Observation::parent-resource::ReferenceValue observation parent_observation_id
ProblemGuid Link to CareRecord - Problem - ProblemGuid Condition::primarycare-condition-partofproblemepisode-extension::ReferenceValue - -
ConsultationGuid Link to CareRecord - Consultation - ConsultationGuid Observation::Encounter::ReferenceValue observation encounter_id
CodeId Links to Coding - CodeId Observation::CodeableConcept::Coding observation non_core_concept_id
CTV3Code The CTV3 Read code for this entry Observation::CodeableConcept::Coding observation non_core_concept_id
CTV3Text The textual description of the CTV3 Read code from the code file Observation::CodeableConcept::Coding observation non_core_concept_id
SNOMEDCode The SNOMED concept ID for this entry Observation::CodeableConcept::Coding observation non_core_concept_id
SNOMEDText The textual description for the SNOMED concept ID Observation::CodeableConcept::Coding observation non_core_concept_id
IsNumeric Whether this coded entry was recorded as a numeric - - -
Value The numeric value for result observations Observation::Quantity::Value observation result_value
NumericUnit Unit Observation::Quantity::Unit observation result_value_units
ObservationType (Episode Type) Type of observation (allergy, immunisation, etc) n/a - -
NumericRangeLow Low Range Observation::ReferenceRange::Low observation_additional property_id,  json_value
NumericRangeHigh High Range Observation::ReferenceRange::High observation_additional property_id,  json_value
DocumentGuid Unique ID for associated attachment Observation::primarycare-external-document-extension::Identifier - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) If true, FHIR resource is deleted - -
IsConfidential Flag to indicate observation is marked as confidential Observation::primarycare-confidential::BooleanValue - -

Referral

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
PatientGuid Link to Patient_Demographics - PatientGuid ReferralRequest::Patient::ReferenceValue referral_request patient_id
OrganisationGuid Link to Organisation - Organisation - OrganisationGuid ReferralRequest::Requester::ReferenceValue (Organization) referral_request requester_organization_id
ObservationGuid Unique ID ReferralRequest::Id referral_request id
ReferralTargetOrganisationGuid Link to Organisation - Organisation - OrganisationGuid ReferralRequest::Recipient::ReferenceValue referral_request recipient_organization_id
ReferralUrgency Urgency of referral ReferralRequest::CodeableConcept::Coding (Priority) referral_request referral_request_priority_concept_id
ReferralServiceType (ServiceOffered) Service type ReferralRequest::CodeableConcept::Coding (Type) referral_request referral_request_type_concept_id
ReferralMode Mode of referral ReferralRequest::primarycare-referral-request-send-mode-extension::Value referral_request mode
Reason The reason for referral ReferralRequest::CodeableConcept::Text (Type) - -
IDProfileReferrer Links to User - UserInRoleGuid ReferralRequest::Requester::ReferenceValue (Practitioner) referral_request practitioner_id
DateEventRecorded Date and time that the event was entered on to the system ReferralRequest::primarycare-recorded-date-extension::DateValue referral_request date_recorded
DateEvent Date and time that the event occurred ReferralRequest::Date::DateValue referral_request clinical_effective_date
IDProfileEnteredBy Links to User - UserInRoleGuid ReferralRequest::primarycare-recorded-by-extension::ReferenceValue - -
IDDoneBy Links to User - UserInRoleGuid ReferralRequest::Requester::ReferenceValue referral_request practitioner_id
PrimaryDiagnosis CTV3 Read code selected as the primary diagnosis against the referral ReferralRequest::CodeableConcept::Coding (Service) referral_request non_core_concept_id
SNOMEDPrimaryDiagnosis SNOMED code selected as the primary diagnosis against the referral ReferralRequest::CodeableConcept::Coding (Service) referral_request non_core_concept_id
RecipientID The national ID of the recipient of the referral (receiving clinician) ReferralRequest::referral-request-recipient-free-text-extension::TextValue - -
RecipientIDType The type of national ID of the referrer (for example GMC) ReferralRequest::referral-request-recipient-free-text-extension::TextValue - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) If true, FHIR resource is deleted - -

Problem

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
PatientGuid Link to Patient_Demographics - PatientGuid Condition::Patient::ReferenceValue observation patient_id
OrganisationGuid Link to Organisation - Organisation - OrganisationGuid - - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) If true, FHIR resource is deleted - -
EndDate Problem end date Condition::AbatementDate::DateValue observation problem_end_date
EndDatePrecision Date accuracy Condition::AbatementDate::DateValue - -
ExpectedDuration Expected duration of problem Condition::primarycare-problem-expectedduration-extension::Value - -
LastReviewDate Date Problem last reviewd Condition::primarycare-problem-lastreviewed-extension::DateValue - -
LastReviewDatePrecision Date accuracy Condition::primarycare-problem-lastreviewed-extension::date::DateValue - -
LastReviewUserInRoleGuid Links to User - UserInRoleGuid Condition::primarycare-problem-lastreviewed-extension::performer::ReferenceValue - -
ProblemStatusDescription Status of the problem Condition::AbatementDate::BooleanValue (Past Problem) - -
SignificanceDescription Problem significance Condition::primarycare-problem-significance-extension::Value observation_additional property_id, value_id

Flag

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
DateAdded (DateStart) The date and time information event was added / date and time note started Flag::Period::Start::DateValue flag effective_date
IDProfileEnteredBy Links to User - UserInRoleGuid Flag::Author::ReferenceValue - -
ProtectionPlan Defines if the patient is on a protection plan for this entry of information Flag::Status::Value flag flag_text
DateRemoved (DateExpired) The date and time the information was removed / date and time note expired Flag::Period::End::DateValue - -
ReasonForPlan (Note) The reason the patient was added to a protection plan / text of note Flag::CodeableConcept::Text flag flag_text
IDPatient Link to Patient_Demographics - PatientGuid Flag::Subject::ReferenceValue flag patient_id
Type The type of special note added (for example, special note, safe haven, frequent caller) n/a flag flag_text
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) If true, FHIR resource is deleted - -

Coding

A reference file containing the coded entries used by the clinical system is to be provided as a separate file within the extract.

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
CodeId Unique ID n/a n/a n/a
Term Code term n/a n/a n/a
Type SNOMED, Read, Ctv3, DM&D ID, Local code, etc. n/a n/a n/a
ParentCodeID Unique ID n/a n/a n/a

Prescribing

Drug Record

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
DrugRecordGuid Unique ID MedicationStatement::Id * medication_statement id
PatientGuid Link to Patient_Demographics - PatientGuid MedicationStatement::Patient::Reference * medication_statement patient_id
OrganisationGuid Link to Organisation - Organisation - OrganisationGuid n/a - -
EffectiveDate Clinically effective date MedicationStatement::DateAsserted medication_statement clinical_effective_date
EffectiveDatePrecision Date accuracy MedicationStatement::DateAsserted medication_statement date_precision_concept_id
EnteredDate Date entered MedicationStatement::primarycare-recorded-date-extension::DateTimeValue medication_statement date_recorded
EnteredTime Time entry was created MedicationStatement::primarycare-recorded-date-extension::DateTimeValue medication_statement date_recorded
ClinicianUserInRoleGuid (IDDoneBy) Link to User - UserInRoleGuid MedicationStatement::InformationSource::Reference * medication_statement practitioner_id
EnteredByUserInRoleGuid Link to User - UserInRoleGuid MedicationStatement::primarycare-recorded-by-extension::ReferenceValue * medication_statement practitioner_id
CodeId (IDMultiLexDMD) Link to Coding - CodeId MedicationStatement::CodeableConcept::Coding medication_statement core_concept_id
Dosage Dosage MedicationStatement::Dosage::Text medication_statement dose
Quantity Quantity MedicationStatement::primarycare-medication-authorisation-quantity-extension::Quantity::Value medication_statement quantity_value
QuantityUnit Unit MedicationStatement::primarycare-medication-authorisation-quantity-extension::Quantity::Unit medication_statement quantity_unit
ProblemObservationGuid Link to Care Record - Observation - ProblemGuid MedicationStatement::Reason::Reference *

(target Condition resource is also updated with a reference back to this one)

- -
PrescriptionType Type of prescription MedicationStatement::primarycare-medication-authorisation-type-extension::CodeableConceptValue *** medication_statement authorisation_type_concept_id
IsActive Is this still active MedicationStatement::Status medication_statement is_active
CancellationDate (DateMedicationEnd) Date of Cancellation MedicationStatement::primarycare-medication-authorisation-cancellation-extension::DateValue medication_statement cancellation_date
NumberOfIssues No. of times drug has been issued on current authorisation MedicationStatement::primarycare-medication-authorisation-numberofrepeatsissued-extension::IntValue - -
NumberOfIssuesAuthorised No. of issues authorised MedicationStatement::primarycare-medication-authorisation-numberofrepeatsallowed-extension::IntValue - -
IsConfidential Flag to indicate observation is marked as confidential MedicationStatement::primarycare-confidential::ValueBoolean (extension only created if value is true) - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) <If true, FHIR resource is deleted> - -
NameOfMedication The name of the medication. MedicationStatement::CodeableConcept::Coding::Text medication_statement core_concept_id
IsOtherMedication Defines whether the medication has been recorded as an 'other' medication instead of an acute n/a - -
IsDentalMedication Defines whether the medication has been recorded as 'dental' medication instead of an acute n/a - -
IsHospitalMedication Defines whether the medication has been recorded as 'hospital' medication instead of an acute n/a - -
IDRepeatTemplate The unique identifier of the Repeat Template the drug was prescribed from MedicationOrder::primarycare-medication-order-authorisation-extension::ValueReference * medication_order medication_statement_id

Issue Record

Publisher DDS Core CollapseCompass V2
Field Name Data/Coding Type FHIR Table Field
IssueRecordGuid Unique ID MedicationOrder::Id * medication_order id
PatientGuid Link to Patient_Demographics - PatientGuid MedicationOrder::Patient::Reference * medication_order patient_id
OrganisationGuid Link to Organisation - Organisation - OrganisationGuid - medication_order organization_id
DrugRecordGuid Link to Prescribing - DrugRecord - DrugRecordGuid MedicationOrder::primarycare-medication-order-authorisation-extension::ValueReference * medication_order medication_statement_id
EffectiveDate The date and time that the event occurred MedicationOrder::DateWritten

(this date is also used to populate the primarycare-medication-authorisation-firstissuedate-extension::ValueDate and primarycare-medication-authorisation-mostrecentissuedate-extension::ValueDate extensions on the FHIR MedicationStatement)

medication_order clinical_effective_date
EffectiveDatePrecision Date accuracy MedicationOrder::DateWritten

(this date is also used to populate the primarycare-medication-authorisation-firstissuedate-extension::ValueDate and primarycare-medication-authorisation-mostrecentissuedate-extension::ValueDate extensions on the FHIR MedicationStatement)

medication_order date_precision_concept_id
EnteredDate Entered date MedicationOrder::primarycare-recorded-date-extension::DateTimeValue medication_order date_recorded
EnteredTime Time entry was created MedicationOrder::primarycare-recorded-date-extension::DateTimeValue medication_order date_recorded
ClinicianUserInRoleGuid (IDDoneBy) Link to User - UserInRoleGuid MedicationOrder::Prescriber::Reference * medication_order practitioner_id
EnteredByUserInRoleGuid Link to User - UserInRoleGuid MedicationOrder::primarycare-recorded-by-extension::ReferenceValue * medication_order practitioner_id
CodeId (IDMultiLexDMD) Link to Prescribing - Drug_Code - CodeId MedicationStatement::CodeableConcept::Coding medication_order core_concept_id
Dosage Dosage MedicationOrder::Dosage::Text medication_order dose
Quantity Quantity MedicationOrder::DispenseRequest::Quantity::Value medication_order quantity_value
QuantityUnit Unit MedicationOrder::DispenseRequest::Quantity::Unit medication_order quantity_unit
ProblemObservationGuid Link to Care Record - Observation - ProblemGuid MedicationOrder::Reason::Reference *

(target Condition resource is also updated with a reference back to this one)

- -
CourseDurationInDays Number of days the course was due to last (where known) MedicationOrder::DispenseRequest.ExpectedSupplyDuration.Value medication_order duration_days
EstimatedNhsCost Estimated NHS cost MedicationOrder::primarycare-medication-order-estimatednhscost-extension::DecimalValue medication_order estimated_cost
IsConfidential Flag to indicate observation is marked as confidential MedicationOrder::primarycare-confidential::ValueBoolean (extension only created if value is true) - -
Deleted Indicates whether the record has been deleted (True/Fales , 0/1) <If true, FHIR resource is deleted> - -
NameOfMedication The name of the medication repeat template. MedicationOrder::CodeableConcept::Coding::Text - -
Retrieved from ‘https://wiki.discoverydataservice.org/index.php?title=Community_data_FHIR_mapping&oldid=6551’