Skip to content

Commit

Permalink
Merge pull request #79 from Alvearie/branding
Browse files Browse the repository at this point in the history
Branding
  • Loading branch information
coxstuart authored May 31, 2022
2 parents 8e4a450 + a344bf1 commit 79dae63
Show file tree
Hide file tree
Showing 90 changed files with 541 additions and 2,856 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Introduction


To build upon FHIR standards, IBM® Watson Health has developed IBM® Health Data Connect. This Common Data Model Implementation Guide supports Health Data Connect data interoperability for a cross-section of healthcare use cases, and refers to the model defined by this implementation guide as the IBM Health Data Connect Common Data Model.
To build upon FHIR standards, this Whole Health Common Data Model Implementation Guide supports Health Data Connect data interoperability for a cross-section of healthcare use cases, and refers to the model defined by this implementation guide as the Health Data Connect Common Data Model.

The Common Data Model extends the industry-standard, base FHIR specification to support the data model requirements needed by healthcare data platform base capabilities, for example, data lineage and resource matching. In addition, the Common Data Model adds elements to support higher-level value that can be driven by a healthcare data platform, including claims data enrichment, care gap analytics, and patient engagement.

Expand Down Expand Up @@ -92,7 +92,6 @@ You must have git configured for signed-by commmits. See [CONTRIBUTING.md](CONT
## License

FHIR® is the registered trademark of HL7 and is used with the permission of HL7. Use of the FHIR trademark does not constitute endorsement of this product by HL7.
IBM and the IBM logo are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on [https://ibm.com/trademark](https://ibm.com/trademark).

## Release History

Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
<div id="hl7-nav">
<a id="alvearie-logo" no-external="true">
<img height="60" alt="Alvearie" src="{{site.data.info.assets}}assets/images/alvearieLogo.png" style="float:left"/>
<!--
// New logo image reference should go here
// Place image in data/alvearie-template/content/assets/images folder
<img height="60" alt="Alvearie" src="{{site.data.info.assets}}assets/images/logoHere.png" style="float:left"/>
-->
</a>
</div>
8 changes: 4 additions & 4 deletions data/input/fsh/elements/ProcessMeta.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Description: "Data lineage meta with process extensions"

* extension contains ProcessOrganization named processOrganization 0..1
* extension[processOrganization] ^short = "The organizing entity that owns the process that has produced the data held in the FHIR resource or element"
* extension[processOrganization] ^definition = "The organizing entity that owns the process that has produced the data held in the FHIR resource or element. Example: If an IBM analytic service has been the producer, the process-organization value is IBM."
* extension[processOrganization] ^definition = "The organizing entity that owns the process that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, the process-organization value should reflect the organaization reponsible for the service."

* extension contains ProcessName named processName 0..1
* extension[processName] ^short = "The name of the process or service that has produced the data held in the FHIR resource or element"
* extension[processName] ^definition = "The name of the process or service that has produced the data held in the FHIR resource or element. Example: If an IBM analytic service has been the producer, use the process-name as the name of that analytic service."
* extension[processName] ^definition = "The name of the process or service that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, use the process-name as the name of that analytic service."

* extension contains ProcessVersion named processVersion 0..1
* extension[processVersion] ^short = "The version of either the process or the service that has produced the data held in the FHIR resource or element"
Expand Down Expand Up @@ -102,13 +102,13 @@ Description: "The ID of the client as recorded in the data producer or data i
Extension: ProcessOrganization
Id: process-organization
Title: "Process Organization"
Description: "The organizing entity that owns the process that has produced the data held in the FHIR resource or element. Example: If an IBM analytic service has been the producer, set the process-organization value to IBM."
Description: "The organizing entity that owns the process that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, the process-organization value should reflect the organaization reponsible for the service."
* value[x] only string

Extension: ProcessName
Id: process-name
Title: "Process Name"
Description: "The name of the process or service that has produced the data held in the FHIR resource or element. Example: If an IBM analytic service has been the producer, use the process-name as the name of that analytic service."
Description: "The name of the process or service that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, use the process-name as the name of that analytic service."
* value[x] only string

Extension: ProcessVersion
Expand Down
2 changes: 1 addition & 1 deletion data/input/fsh/extensions/CommunicationExtensions.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Description: "Mode of communication (phone | sms | email | mail | chat)"
Extension: ConversationType
Id: conversation-type
Title: "Conversation Type"
Description: "Type of conversation, used for ihe chat communications"
Description: "Type of conversation, used for chat communications"
* value[x] only CodeableConcept
* valueCodeableConcept from EngagementConversationTypeValueSet (extensible)

Expand Down
20 changes: 20 additions & 0 deletions data/input/fsh/extensions/EncounterExtensions.fsh
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Extension: InsuredRank
Id: insured-rank
Title: "Insured Rank"
Description: "Ordered rank to associate with an insurance option within a particular context (such as an Encounter)"
* value[x] only positiveInt

Extension: InsuredCategory
Id: insured-category
Title: "Insured Category"
Description: "Category of insurance"
* value[x] only CodeableConcept
* valueCodeableConcept from InsuredCategoryValueSet (extensible)

Extension: Insured
Id: insured
Title: "Insured"
Description: "Container for elements providing insurance context"
* extension contains
InsuredRank named insuredRank 0..1 and
InsuredCategory named insuredCategory 0..*
2 changes: 1 addition & 1 deletion data/input/fsh/resources/appointment/CDM_Apppointment.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMAppointment
Parent: Appointment
Id: cdm-appointment
Title: "CDM Appointment"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for an appointment"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for an appointment"
* contained 0..0
* meta only ProcessMeta

Expand Down
2 changes: 1 addition & 1 deletion data/input/fsh/resources/careplan/CDM_CarePlan.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMCarePlan
Parent: CarePlan
Id: cdm-careplan
Title: "CDM CarePlan"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for a care plan"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for a care plan"
* contained 0..0
* meta only ProcessMeta

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMCommunication
Parent: Communication
Id: cdm-communication
Title: "CDM Communication"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for a communication"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for a communication"
* contained 0..0
* meta only ProcessMeta

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMCommunicationRequest
Parent: CommunicationRequest
Id: cdm-communication-request
Title: "CDM CommunicationRequest"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for a communication request"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for a communication request"
* contained 0..0
* meta only ProcessMeta

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Description: "This profile is a record of an engagement communication to a pa

* extension contains ConversationType named conversationType 0..1
* extension[conversationType].valueCodeableConcept from EngagementConversationTypeValueSet (extensible)
* extension[conversationType] ^short = "Type of conversation, used for ihe chat communications"
* extension[conversationType] ^definition = "Type of conversation, used for ihe chat communications"
* extension[conversationType] ^short = "Type of conversation, used for chat communications"
* extension[conversationType] ^definition = "Type of conversation, used for chat communications"

* extension contains CommunicationReengagement named communicationReengagement 0..1
* extension[communicationReengagement] ^short = "Sequence for subsequent communication attempts to reengage the patient"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Description: "This profile is a record of an engagement request for a communi

* extension contains ConversationType named conversationType 0..1
* extension[conversationType].valueCodeableConcept from EngagementConversationTypeValueSet (extensible)
* extension[conversationType] ^short = "Type of conversation, used for ihe chat communications"
* extension[conversationType] ^definition = "Type of conversation, used for ihe chat communications"
* extension[conversationType] ^short = "Type of conversation, used for chat communications"
* extension[conversationType] ^definition = "Type of conversation, used for chat communications"

* extension contains CommunicationReengagement named communicationReengagement 0..1
* extension[communicationReengagement] ^short = "Sequence for subsequent communication attempts to reengage the patient"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ Instance: EngagementCommunicationRequestExample
InstanceOf: EngagementCommunicationRequest
Usage: #example
Title: "Engagement Communication Request Example"
Description: "Example of an engagement communication request to send an Outreach text to a patient concerning a care gap"
Description: "Example of an engagement communication request to send a SMS text to a patient concerning a care gap"

* meta.source = "http://ibm.com/fhir/engagement"
* meta.profile = "http://ibm.com/fhir/cdm/StructureDefinition/engagement-communication-request"

* meta.extension[tenantId].valueString = "99999"
* meta.extension[ingestionBatchId].valueString = "b069a545-9506-40c6-8498-23de2e189143"
* meta.extension[processOrganization].valueString = "IBM"
* meta.extension[processOrganization].valueString = "HDC"
* meta.extension[processType].valueString = "Engagement Communication"
* meta.extension[processName].valueString = "ATC"
* meta.extension[processVersion].valueString = "1.0"
Expand All @@ -19,7 +19,7 @@ Description: "Example of an engagement communication request to send an Outre
* identifier[0].type = IdentifierTypeCodeSystem#DRI
* identifier[0].system = "http://ibm.com/fhir/cdm/engagement-communication-request"
* identifier[0].value = "0bd930b0-e2fc-4967-957d-a6719ecde9b4"
* identifier[0].assigner.display = "IBM"
* identifier[0].assigner.display = "HDC"

* status = #completed
* statusReason = EngagementCommunicationRequestStatusReasonCodeSystem#request-complete "In-Process - Communication request complete"
Expand All @@ -29,7 +29,7 @@ Description: "Example of an engagement communication request to send an Outre
* priority = #routine
* category = COMMUNICATION-CATEGORY#notification

* extension[communicationProduct].valueCodeableConcept = EngagementProductCodeSystem#ihe
* extension[communicationProduct].valueCodeableConcept = EngagementProductCodeSystem#care-gap
* extension[conversationType].valueCodeableConcept = EngagementConversationTypeCodeSystem#gap-in-care
* extension[communicationOnBehalfOf].valueReference = Reference(CDMPractitionerRole-Attributed-PCP)

Expand Down Expand Up @@ -59,7 +59,7 @@ Description: "Example of an engagement communication request to send an Outre
* occurrencePeriod.end = "2020-06-16T20:00:00Z"
* authoredOn = "2020-06-16T03:00:00Z"

* requester = Reference(IBM)
* requester = Reference(HDC)
* recipient = Reference(CDMPatientInstance)
* sender = Reference(IBM)
* sender = Reference(HDC)
* extension[communicationVendor].valueReference = Reference(CommunicationVendor1)
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ Instance: EngagementCommunicationExample
InstanceOf: EngagementCommunication
Usage: #example
Title: "Engagement Communication Example"
Description: "Example of an engagement communication to send an Outreach text to a patient concerning a care gap"
Description: "Example of an engagement communication to send a SMS text to a patient concerning a care gap"

* meta.source = "http://ibm.com/fhir/engagement"
* meta.profile = "http://ibm.com/fhir/cdm/StructureDefinition/engagement-communication"

* meta.extension[tenantId].valueString = "99999"
* meta.extension[ingestionBatchId].valueString = "b069a545-9506-40c6-8498-23de2e189143"
* meta.extension[processOrganization].valueString = "IBM"
* meta.extension[processOrganization].valueString = "HDC"
* meta.extension[processType].valueString = "Engagement Communication"
* meta.extension[processName].valueString = "ATC"
* meta.extension[processVersion].valueString = "1.0"
Expand All @@ -19,7 +19,7 @@ Description: "Example of an engagement communication to send an Outreach text
* identifier.type = IdentifierTypeCodeSystem#DRI
* identifier.system = "http://ibm.com/fhir/cdm/engagement-communication"
* identifier.value = "de25d288-120e-47c1-bb76-caac8bc3f439"
* identifier.assigner.display = "IBM"
* identifier.assigner.display = "HDC"

* basedOn = Reference(EngagementCommunicationRequestExample)

Expand All @@ -34,7 +34,7 @@ Description: "Example of an engagement communication to send an Outreach text
* priority = #routine
* category = COMMUNICATION-CATEGORY#notification

* extension[communicationProduct].valueCodeableConcept = EngagementProductCodeSystem#ihe
* extension[communicationProduct].valueCodeableConcept = EngagementProductCodeSystem#care-gap
* extension[conversationType].valueCodeableConcept = EngagementConversationTypeCodeSystem#gap-in-care
* extension[communicationOnBehalfOf].valueReference = Reference(CDMPractitionerRole-Attributed-PCP)

Expand Down Expand Up @@ -63,5 +63,5 @@ Description: "Example of an engagement communication to send an Outreach text
* extension[communicationVendor].valueReference = Reference(Genesis)

* recipient = Reference(CDMPatientInstance)
* sender = Reference(IBM)
* sender = Reference(HDC)
* extension[communicationVendor].valueReference = Reference(CommunicationVendor1)
2 changes: 1 addition & 1 deletion data/input/fsh/resources/condition/CDM_Condition.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMCondition
Parent: Condition
Id: cdm-condition
Title: "CDM Condition"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for a condition"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for a condition"

// Adding inline resources as contained resources for references
* contained 0..*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMDetectedIssue
Parent: DetectedIssue
Id: cdm-detected-issue
Title: "CDM Detected Issue"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for a detected issue"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for a detected issue"
* contained 0..0
* meta only ProcessMeta

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Description: "Example of an detected issue indicating that the patient was in

* meta.extension[tenantId].valueString = "99999"
* meta.extension[ingestionBatchId].valueString = "b069a545-9506-40c6-8498-23de2e189143"
* meta.extension[processOrganization].valueString = "IBM"
* meta.extension[processOrganization].valueString = "HDC"
* meta.extension[processType].valueString = "Cohorting"
* meta.extension[processName].valueString = "Powersearch"
* meta.extension[processVersion].valueString = "1.0"
Expand All @@ -18,7 +18,7 @@ Description: "Example of an detected issue indicating that the patient was in
* identifier.type = IdentifierTypeCodeSystem#DRI
* identifier.system = "http://ibm.com/fhir/cdm/care-gap-detected-issue"
* identifier.value = "d90a8ceb-6f1a-4bc6-8d2a-8c00e6ea8a3e"
* identifier.assigner.display = "IBM"
* identifier.assigner.display = "HDC"

* status = #final

Expand All @@ -43,7 +43,7 @@ Description: "Example of a related care gap detected issue that has been reso
* identifier.type = IdentifierTypeCodeSystem#DRI
* identifier.system = "http://ibm.com/fhir/cdm/care-gap-detected-issue"
* identifier.value = "4dee9608-e1e0-4653-9f75-b7bdb8d3a968"
* identifier.assigner.display = "IBM"
* identifier.assigner.display = "HDC"

* status = #final
* patient = Reference(CDMPatientInstance)
Expand Down
2 changes: 1 addition & 1 deletion data/input/fsh/resources/eligibility/CDM_Eligibility.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMEligibility
Parent: Bundle
Id: cdm-eligibility
Title: "CDM Eligibility"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for an eligibility record"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for an eligibility record"
* type = #document
* meta only ProcessMeta
* entry ^slicing.ordered = false
Expand Down
2 changes: 1 addition & 1 deletion data/input/fsh/resources/eligibility/CDM_InsurancePlan.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMInsurancePlan
Parent: InsurancePlan
Id: cdm-insurance-plan
Title: "CDM Insurance Plan"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for an insurance plan"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for an insurance plan"
* contained 0..0
* meta only ProcessMeta

Expand Down
8 changes: 6 additions & 2 deletions data/input/fsh/resources/encounter/CDM_Encounter.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMEncounter
Parent: Encounter
Id: cdm-encounter
Title: "CDM Encounter"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for an encounter"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for an encounter"
* contained 0..0
* meta only ProcessMeta

Expand All @@ -27,4 +27,8 @@ Description: "IBM Health Data Connect Common Data Model definition of what fi
* identifier[Source].system 1..1
* identifier[Source].value 1..1

* class from EncounterClassValueSet (extensible)
* class from EncounterClassValueSet (extensible)

* extension contains Insured named insured 0..*
* extension[insured] ^short = "Insurance context for the encounter"
* extension[insured] ^definition = "Insurance context for the encounter"
2 changes: 1 addition & 1 deletion data/input/fsh/resources/initiative/FFV_Initiative.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Profile: FFVInitiative
Parent: Contract
Id: ffv-initative-resource
Title: "Fee for Value Initative"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for an FFV initiative record"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for an FFV initiative record"
* contained 0..0
* meta only ProcessMeta

Expand Down
2 changes: 1 addition & 1 deletion data/input/fsh/resources/library/CDM_Library.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Profile: CDMLibrary
Parent: Library
Id: cdm-library
Title: "CDM Library"
Description: "IBM Health Data Connect Common Data Model definition of what fields we currently define for a library"
Description: "Health Data Connect Common Data Model definition of what fields we currently define for a library"

* contained 0..0
* meta only ProcessMeta
Expand Down
Loading

0 comments on commit 79dae63

Please sign in to comment.