This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Editing Tasks"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "Return to Orders & Observations Work Group Return to Ordering Service Project Page Return to Order_Catalog_Inte...")
 
 
(87 intermediate revisions by 4 users not shown)
Line 5: Line 5:
 
Return to [[Order_Catalog_Interface|Catalog Project Page]]
 
Return to [[Order_Catalog_Interface|Catalog Project Page]]
  
* Rename Catalog Entry to Entry Definition
+
==Deadlines==
* Fix the reference to CatalogEntry in Catalog after re-naming
+
 
* Add SpecimenDefinition and ObservationDefinition to the relatedItem choice list
+
*Review of the catalog related resource proposals with FMG: June 12th FMG call
* Add ObservationDefinition to the build based on google spreadsheet linked from Order Catalog page
+
*Substantive content freeze :
* Begin analysis of ActivityDefinition for a Lab Service Profile
+
*Final Content freeze:
 +
*Ballot opens:
 +
*Ballot closes:
 +
 
 +
==To Do post May 2019 Montreal connectathon==
 +
 
 +
*CatalogEntry - add estimatedDuration 0..1 Duration Estimated duration of orderable item -> tracker [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=21244&start=0 21244)] DONE (Rob)
 +
*SpecimenDefinition - add singleUse  0..1  boolean as sub-element of SpecimenDefinition.typeTested -> tracker [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=21251&start=0 21251] DONE (Rob)
 +
*SpecimenDefinition - Add testingDestination 0..* CodeableConcept    where the specimen will be tested: lab, sector, device or any combination of these. -> tracker [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=21287&start=0 21287] DONE (Rob)
 +
*SpecimenDefinition - conformance to the Definition pattern -> tracker [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=22644&start=0 22644] DONE (François, Rob)
 +
*ObservationDefinition - conformance to the Definition pattern + add more properties from Observation. -> tracker [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=22643&start=0 22643] DONE (François, Rob)
 +
 
 +
==To Do for May 2019 connectathon in Montreal==
 +
 
 +
*ActivityDefinition:
 +
**Allow an activity to reference sub-activities -> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=20406 20406] pushed back by CDS in April 2019. Tracker withdrawned. An ActivityDefinition represents an atomic activity.
 +
**Allow specimen requirements to combine multiple specimens with logical AND (all present in the list), as well as with logical XOR (only one in the list) -> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=20553 20553] to be approved by CDS (Claude to follow-up)
 +
*SpecimenDefinition
 +
**Define operation $apply to generate instance of Specimen conforming to the content of SpecimenDefinition -> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=20554&start=0 20554] and SpecimenDefinition spreadsheet format updated. To be approved by the group and by OO
 +
 
 +
==To Do post September Connectathon==
 +
 
 +
*ObservationDefinition:
 +
**Change datatype of the last 4 elements (validCodedValueSet, normalCodedValueSet, ...) from uri to Reference(ValueSet) -> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=18995 18995] DONE
 +
**Clarify definition of qualifiedInterval ("Qualified range for continuous and ordinal observation results") -> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=17429 17429] DONE (changed mapping from OM-2 to OM2-6)
 +
*CatalogEntry
 +
**Complement V2 mappings to the MFE segment -> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=18996 18996]
 +
**Update the whole content per the decisions made during the December 12 catalog call -> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=19783&start=0 19783] DONE (thanks to Rob for the build)
 +
*SpecimenDefinition: --> All items below DONE (thanks to Rob for the build)
 +
**change patientPreparation from string 0..1 to CodeableConcept 0..*. An example value set is: < 703763000 |Precondition value (qualifier value)| from SNOMED CT. Multiple pre-conditions or preparations can be specified, hence the cardinalities 0..*. In case there is no coded concept, the text element of CodeableConcept can be used. --> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=19419 19419]
 +
**Correct value set of container.type to: < 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)| SNOMED CT --> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=19422 19422]
 +
**Provide value set for container.material (glass, plastic, metal ... see Specimen DAM) --> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=19425 19425]
 +
**Provide value set for collection (binding strength Example) --> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=19426 19426]
 +
**Sometimes, the minimum volume may appear as a textual instruction. Therefore change minimumVolume from SimpleQuantity to a choice {SimpleQuantity, string} --> RT [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=19423 19423]
 +
**Challenge the usefulness of isDerived boolean element. In V2 OM4-2 “Derived specimen” uses table 0170 to specify whether the specimen is parent (e.g. blood culture) or child (e.g. pure colony isolate). Do we really need this element in SpecimenDefinition?
 +
*Coverage on examples: François provided for SpecimenDefinition and ObservationDefinition. Needed for other kinds of catalogs (medications, devices)
 +
*we should discuss Human Services use cases - look at our example use cases --> NEED TO ASSIGN TO SOMEONE
 +
*Profile on ActivityDefinition (NEED TO ASSIGN TO SOMEONE AFTER SEPT) --> François
 +
 
 +
==To Do for September Connectathon==
 +
 
 +
*rename EntryDefinition to CatalogEntry --> DONE by Claude
 +
*Add scope and boundary text to resource -- DONE by Claude
 +
*Relationships from Activity Definition to SpecimenDefinition and ObservationDefinition --> DONE by Bryn
 +
*[http://wiki.hl7.org/index.php?title=Ballot_comments_from_January_2018_ballot Tracker items from ballot] -  François prepared proposed resolutions for block vote. --> DONE
 +
*review value set bindings and definitions (François to do) --> DONE, review the proposals in the Post September Connectathon section above.
 +
*review relationship types in Catalog Entry (François to do): remove has-input, has-output and uses from the list --> DONE
 +
*ObservationDefinition cleanup:
 +
**Replace Coding by CodeableConcept on category and code --> DONE
 +
**Add element identifier (discovered as useful for Quest, and probably to most labs for internal identifier) --> DONE
 +
**I think element permittedDatatype should be of type code, with fhir value-set {quantity, time, string, CodeableConcept, ...etc) (Waiting to get core value set reference from Lorraine) --> DONE
 +
**Correct value set binding of qualifiedInterval.category: This is not a category of observation. An example value set would be: {"reference", "critical", "absolute"} --> DONE
 +
**Fix definitions for qualifiedInterval.category and qualifiedInterval.type (Actually, review all definitions for clarity and completeness) (FRANCOIS) --> DONE, see left over in section "Post September Connectathon" above.
 +
**qualifiedInterval.range: Correct the description from "Low bound of reference range, if relevant" to "range of the interval", also changed long description --> DONE
 +
*SpecimenDefinition: Apply resolutions of trackers listed [http://wiki.hl7.org/index.php?title=Ballot_comments_from_January_2018_ballot here] --> DONE
 +
*Connectathon proposal
 +
**François to flesh out use cases with Quest --> DONE
 +
*Claude to re-set up to add to build --> DONE
 +
 
 +
==Done Items (June)==
 +
 
 +
*EntryDefinition: Rename purpose (1..1, CodeableConcept) to orderable (1..1, boolean) ---> Done!
 +
*EntryDefinition.status:  Change datatype from CodeableConcept to code, change cardinality to 1..1, and assign FHIR value set [http://build.fhir.org/valueset-publication-status.html PublicationStatus](required), (values: draft | active | retired | unknown). ---> Done!
 +
*EntryDefinition.relatedEntry.relationType: Change datatype from CodeableConcept to code, and define FHIR value set (required) with these values:
 +
**has-input: the related entry represents an item to be provided as input to the current item
 +
**has-output: the related entry represents an item produced as out put of the current item
 +
**uses: the related entry represents an item (product or material or substance) used by the current item
 +
**triggers: the related entry represents an activity that may be triggered by the current item
 +
**is-replaced-by: the related entry represents an item that replaces the current retired item
 +
 
 +
---> Done! Thanks Jose!
 +
 
 +
==To Do Items for June==
 +
 
 +
*ObservationDefinition: various corrections
 +
**Correct datatype of elements category and code: from Coding to CodeableConcept
 +
**bind category to value set http://hl7.org/fhir/ValueSet/observation-category (preferred)
 +
**Correct datatype of element permittedDataType from Coding to code, with the binding to the FHIR value set {Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period} (required)
 +
**Correct the definition of ObservationDefinition.qualifiedInterval from "Reference range for ordinal and continuous observations." to "Reference range for ordinal and quantity measurement observations."
 +
 
 +
EntryDefinition.type: Assign value set. The content of type represents the type of resource referenced by referencedItem (Medication, Device, Observation, ActivityDefinition, ...) How can we enforce that? [NOTE: WE DECIDED TO DEFER THIS UNTIL WE HAVE A CONCRETE USE CASE THAT WARRANT ITS USE.]
 +
 
 +
*ActivityDefinition timingTiming (Timing) - confirm ability to carry a performance schedule as in eDos ---> Done!
 +
**an example of a performance schedule is "every Monday & Wednesday"
 +
**Yes, this is confirmed. The datatype Timing supports quite complex performance schedules, if needed.
 +
 
 +
==Other to dos==
 +
 
 +
*Review all value sets and value set bindings
 +
**Add Knowledge Artifact and Order Set to the value set for type
 +
**review relationshipType value set - also look at similar one from Task
 +
*Review element definitions
 +
*Add search parameters to each resource - see connectathon report for suggestions for EntryDefinition
 +
*Prepare design summary in preparation for meeting with Lloyd
 +
*Add examples from connectathon to build
 +
*Review and prepare dispositions for comments from January ballot
 +
 
 +
==Items for Future Cycles==
 +
Define Implementation Guide resource and content to contain the appropriate StructureDefinitions and Resources

Latest revision as of 15:33, 16 August 2019

Return to Orders & Observations Work Group

Return to Ordering Service Project Page

Return to Catalog Project Page

Deadlines

  • Review of the catalog related resource proposals with FMG: June 12th FMG call
  • Substantive content freeze :
  • Final Content freeze:
  • Ballot opens:
  • Ballot closes:

To Do post May 2019 Montreal connectathon

  • CatalogEntry - add estimatedDuration 0..1 Duration Estimated duration of orderable item -> tracker 21244) DONE (Rob)
  • SpecimenDefinition - add singleUse 0..1 boolean as sub-element of SpecimenDefinition.typeTested -> tracker 21251 DONE (Rob)
  • SpecimenDefinition - Add testingDestination 0..* CodeableConcept where the specimen will be tested: lab, sector, device or any combination of these. -> tracker 21287 DONE (Rob)
  • SpecimenDefinition - conformance to the Definition pattern -> tracker 22644 DONE (François, Rob)
  • ObservationDefinition - conformance to the Definition pattern + add more properties from Observation. -> tracker 22643 DONE (François, Rob)

To Do for May 2019 connectathon in Montreal

  • ActivityDefinition:
    • Allow an activity to reference sub-activities -> RT 20406 pushed back by CDS in April 2019. Tracker withdrawned. An ActivityDefinition represents an atomic activity.
    • Allow specimen requirements to combine multiple specimens with logical AND (all present in the list), as well as with logical XOR (only one in the list) -> RT 20553 to be approved by CDS (Claude to follow-up)
  • SpecimenDefinition
    • Define operation $apply to generate instance of Specimen conforming to the content of SpecimenDefinition -> RT 20554 and SpecimenDefinition spreadsheet format updated. To be approved by the group and by OO

To Do post September Connectathon

  • ObservationDefinition:
    • Change datatype of the last 4 elements (validCodedValueSet, normalCodedValueSet, ...) from uri to Reference(ValueSet) -> RT 18995 DONE
    • Clarify definition of qualifiedInterval ("Qualified range for continuous and ordinal observation results") -> RT 17429 DONE (changed mapping from OM-2 to OM2-6)
  • CatalogEntry
    • Complement V2 mappings to the MFE segment -> RT 18996
    • Update the whole content per the decisions made during the December 12 catalog call -> RT 19783 DONE (thanks to Rob for the build)
  • SpecimenDefinition: --> All items below DONE (thanks to Rob for the build)
    • change patientPreparation from string 0..1 to CodeableConcept 0..*. An example value set is: < 703763000 |Precondition value (qualifier value)| from SNOMED CT. Multiple pre-conditions or preparations can be specified, hence the cardinalities 0..*. In case there is no coded concept, the text element of CodeableConcept can be used. --> RT 19419
    • Correct value set of container.type to: < 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)| SNOMED CT --> RT 19422
    • Provide value set for container.material (glass, plastic, metal ... see Specimen DAM) --> RT 19425
    • Provide value set for collection (binding strength Example) --> RT 19426
    • Sometimes, the minimum volume may appear as a textual instruction. Therefore change minimumVolume from SimpleQuantity to a choice {SimpleQuantity, string} --> RT 19423
    • Challenge the usefulness of isDerived boolean element. In V2 OM4-2 “Derived specimen” uses table 0170 to specify whether the specimen is parent (e.g. blood culture) or child (e.g. pure colony isolate). Do we really need this element in SpecimenDefinition?
  • Coverage on examples: François provided for SpecimenDefinition and ObservationDefinition. Needed for other kinds of catalogs (medications, devices)
  • we should discuss Human Services use cases - look at our example use cases --> NEED TO ASSIGN TO SOMEONE
  • Profile on ActivityDefinition (NEED TO ASSIGN TO SOMEONE AFTER SEPT) --> François

To Do for September Connectathon

  • rename EntryDefinition to CatalogEntry --> DONE by Claude
  • Add scope and boundary text to resource -- DONE by Claude
  • Relationships from Activity Definition to SpecimenDefinition and ObservationDefinition --> DONE by Bryn
  • Tracker items from ballot - François prepared proposed resolutions for block vote. --> DONE
  • review value set bindings and definitions (François to do) --> DONE, review the proposals in the Post September Connectathon section above.
  • review relationship types in Catalog Entry (François to do): remove has-input, has-output and uses from the list --> DONE
  • ObservationDefinition cleanup:
    • Replace Coding by CodeableConcept on category and code --> DONE
    • Add element identifier (discovered as useful for Quest, and probably to most labs for internal identifier) --> DONE
    • I think element permittedDatatype should be of type code, with fhir value-set {quantity, time, string, CodeableConcept, ...etc) (Waiting to get core value set reference from Lorraine) --> DONE
    • Correct value set binding of qualifiedInterval.category: This is not a category of observation. An example value set would be: {"reference", "critical", "absolute"} --> DONE
    • Fix definitions for qualifiedInterval.category and qualifiedInterval.type (Actually, review all definitions for clarity and completeness) (FRANCOIS) --> DONE, see left over in section "Post September Connectathon" above.
    • qualifiedInterval.range: Correct the description from "Low bound of reference range, if relevant" to "range of the interval", also changed long description --> DONE
  • SpecimenDefinition: Apply resolutions of trackers listed here --> DONE
  • Connectathon proposal
    • François to flesh out use cases with Quest --> DONE
  • Claude to re-set up to add to build --> DONE

Done Items (June)

  • EntryDefinition: Rename purpose (1..1, CodeableConcept) to orderable (1..1, boolean) ---> Done!
  • EntryDefinition.status: Change datatype from CodeableConcept to code, change cardinality to 1..1, and assign FHIR value set PublicationStatus(required), (values: draft | active | retired | unknown). ---> Done!
  • EntryDefinition.relatedEntry.relationType: Change datatype from CodeableConcept to code, and define FHIR value set (required) with these values:
    • has-input: the related entry represents an item to be provided as input to the current item
    • has-output: the related entry represents an item produced as out put of the current item
    • uses: the related entry represents an item (product or material or substance) used by the current item
    • triggers: the related entry represents an activity that may be triggered by the current item
    • is-replaced-by: the related entry represents an item that replaces the current retired item

---> Done! Thanks Jose!

To Do Items for June

  • ObservationDefinition: various corrections
    • Correct datatype of elements category and code: from Coding to CodeableConcept
    • bind category to value set http://hl7.org/fhir/ValueSet/observation-category (preferred)
    • Correct datatype of element permittedDataType from Coding to code, with the binding to the FHIR value set {Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period} (required)
    • Correct the definition of ObservationDefinition.qualifiedInterval from "Reference range for ordinal and continuous observations." to "Reference range for ordinal and quantity measurement observations."

EntryDefinition.type: Assign value set. The content of type represents the type of resource referenced by referencedItem (Medication, Device, Observation, ActivityDefinition, ...) How can we enforce that? [NOTE: WE DECIDED TO DEFER THIS UNTIL WE HAVE A CONCRETE USE CASE THAT WARRANT ITS USE.]

  • ActivityDefinition timingTiming (Timing) - confirm ability to carry a performance schedule as in eDos ---> Done!
    • an example of a performance schedule is "every Monday & Wednesday"
    • Yes, this is confirmed. The datatype Timing supports quite complex performance schedules, if needed.

Other to dos

  • Review all value sets and value set bindings
    • Add Knowledge Artifact and Order Set to the value set for type
    • review relationshipType value set - also look at similar one from Task
  • Review element definitions
  • Add search parameters to each resource - see connectathon report for suggestions for EntryDefinition
  • Prepare design summary in preparation for meeting with Lloyd
  • Add examples from connectathon to build
  • Review and prepare dispositions for comments from January ballot

Items for Future Cycles

Define Implementation Guide resource and content to contain the appropriate StructureDefinitions and Resources