Update Doc for Filters #365

sowu880 · 2022-03-22T07:40:46Z

Give more detailed descriptions and examples for our date and datetime related filters

Create New Release 4.3.0

Create New Release 4.4.0

* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update Filters-and-Tags.md * Update README.md * Update README.md * Update README.md

Release request

BoyaWu10 · 2022-03-22T07:57:17Z

docs/Filters-and-Tags.md

-| add_hyphens_date | Adds hyphens to a date without hyphens | `{{ PID.7.Value \| add_hyphens_date }}` |
-| format_as_date_time | Converts an YYYYMMDDHHmmssSSS string (e.g. 20040629175400000) to a dateTime format (e.g. 2004-06-29T17:54:00.000z). Provides parameters to handle time zone: `preserve`, `utc`, `local`. The default method is `local`. | `{{ PID.29.Value \| format_as_date_time: 'utc' }}` |
+| add_hyphens_date | Adds hyphens to a date or partial date without hyphens. The input date format is YYYY, YYYYMM, or YYYYMMDD. The output format is valid FHIR date or partial date format: YYYY, YYYY-MM, or YYYY-MM-DD.  | `{{ PID.7.Value \| add_hyphens_date }}` |
+| format_as_date_time | Converts valid [HL7v2 and C-CDA datetime](https://hl7-definition.caristix.com/v2/HL7v2.8/DataTypes/DTM)  (datetime or partial datetime without hyphens, e.g. 20040629175400000) to valid [FHIR datetime format](http://hl7.org/fhir/R4/datatypes.html) (e.g. 2004-06-29T17:54:00.000Z). Provides parameters to handle time zone: `preserve`, `utc`, `local`. The default method is `preserve`. | `{{ PID.29.Value \| format_as_date_time: 'utc' }}` |


It is mentioned in previous discussion that we may not able to quote references of this website directly. We can put the format here instead of adding a link.

BoyaWu10 · 2022-03-22T08:01:47Z

docs/Filters-and-Tags.md

+```
+
+> [Note] : If the input is a partial datetime without time zone, it will be set to the first day of the year and 00:00:00 clock time with local time zone as suffix. e.g. In the location with +08:00 time zone, the input string "201101031434" will be filled to "20110103143400+0800",
+   the template `{{ "201101031434"| format_as_date_time: 'utc'}}` will output 2011-01-03T06:34:00Z at +08:00 location.


Nit: the template {{ "201101031434" | format_as_date_time: 'utc'}} will output 2011-01-03T06:34:00Z when running at +08:00 location.

ginalee-dotcom · 2022-03-29T18:42:03Z

docs/Filters-and-Tags.md

@@ -55,10 +55,43 @@ If these filters do not meet your needs, you can also write your own filters.
 ### DateTime filters
 | Filter | Description | Syntax |
 |-|-|-|
-| add_hyphens_date | Adds hyphens to a date without hyphens | `{{ PID.7.Value \| add_hyphens_date }}` |
-| format_as_date_time | Converts an YYYYMMDDHHmmssSSS string (e.g. 20040629175400000) to a dateTime format (e.g. 2004-06-29T17:54:00.000z). Provides parameters to handle time zone: `preserve`, `utc`, `local`. The default method is `local`. | `{{ PID.29.Value \| format_as_date_time: 'utc' }}` |
+| add_hyphens_date | Adds hyphens to a date or partial date without hyphens. The input date format is YYYY, YYYYMM, or YYYYMMDD. The output format is valid FHIR date or partial date format: YYYY, YYYY-MM, or YYYY-MM-DD.  | `{{ PID.7.Value \| add_hyphens_date }}` |


nit: Adds hyphens to a date or a partial date that does not have hyphens to make it into a valid FHIR format. The input date format is YYYY, YYYYMM, or YYYYMMDD. The output format is a valid FHIR date or a partial date format: YYYY, YYYY-MM, or YYYY-MM-DD.

ginalee-dotcom · 2022-03-29T18:47:40Z

docs/Filters-and-Tags.md

-| add_hyphens_date | Adds hyphens to a date without hyphens | `{{ PID.7.Value \| add_hyphens_date }}` |
-| format_as_date_time | Converts an YYYYMMDDHHmmssSSS string (e.g. 20040629175400000) to a dateTime format (e.g. 2004-06-29T17:54:00.000z). Provides parameters to handle time zone: `preserve`, `utc`, `local`. The default method is `local`. | `{{ PID.29.Value \| format_as_date_time: 'utc' }}` |
+| add_hyphens_date | Adds hyphens to a date or partial date without hyphens. The input date format is YYYY, YYYYMM, or YYYYMMDD. The output format is valid FHIR date or partial date format: YYYY, YYYY-MM, or YYYY-MM-DD.  | `{{ PID.7.Value \| add_hyphens_date }}` |
+| format_as_date_time | Converts valid HL7v2 and C-CDA datetime  (datetime or partial datetime without hyphens ：YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ] , e.g. 20040629175400000) to valid [FHIR datetime format](http://hl7.org/fhir/R4/datatypes.html) (e.g. 2004-06-29T17:54:00.000Z). Provides parameters to handle time zone: `preserve`, `utc`, `local`. The default method is `preserve`. | `{{ PID.29.Value \| format_as_date_time: 'utc' }}` |


Converts valid HL7v2 and C-CDA datetime to a valid FHIR datetime format. The input datetime format is datetime or partial datetime without hyphens: YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ]. For example, the input 20040629175400000 will have the output 2004-06-29T17:54:00.000Z. Provides parameters to handle different time zones: preserve, utc, local. The default method is preserve.

ginalee-dotcom · 2022-03-29T18:50:32Z

docs/Filters-and-Tags.md

-| add_hyphens_date | Adds hyphens to a date without hyphens | `{{ PID.7.Value \| add_hyphens_date }}` |
-| format_as_date_time | Converts an YYYYMMDDHHmmssSSS string (e.g. 20040629175400000) to a dateTime format (e.g. 2004-06-29T17:54:00.000z). Provides parameters to handle time zone: `preserve`, `utc`, `local`. The default method is `local`. | `{{ PID.29.Value \| format_as_date_time: 'utc' }}` |
+| add_hyphens_date | Adds hyphens to a date or partial date without hyphens. The input date format is YYYY, YYYYMM, or YYYYMMDD. The output format is valid FHIR date or partial date format: YYYY, YYYY-MM, or YYYY-MM-DD.  | `{{ PID.7.Value \| add_hyphens_date }}` |
+| format_as_date_time | Converts valid HL7v2 and C-CDA datetime  (datetime or partial datetime without hyphens ：YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ] , e.g. 20040629175400000) to valid [FHIR datetime format](http://hl7.org/fhir/R4/datatypes.html) (e.g. 2004-06-29T17:54:00.000Z). Provides parameters to handle time zone: `preserve`, `utc`, `local`. The default method is `preserve`. | `{{ PID.29.Value \| format_as_date_time: 'utc' }}` |
 | now | Provides current time in a specific format. The default format is "yyyy-MM-ddTHH:mm:ss.FFFZ". | `{{ '' \| now: 'dddd, dd MMMM yyyy HH:mm:ss' }}` |


nit: Provides the current time in a specific format. The default format is yyyy-MM-ddTHH:mm:ss.FFFZ.

ginalee-dotcom · 2022-03-29T19:05:40Z

docs/Filters-and-Tags.md

 | now | Provides current time in a specific format. The default format is "yyyy-MM-ddTHH:mm:ss.FFFZ". | `{{ '' \| now: 'dddd, dd MMMM yyyy HH:mm:ss' }}` |
-| add_seconds | Adds double seconds on datetime in FHIR format. Provides parameters to set time zones: `preserve`, `utc`, `local`. The default is set to the parameter `preserve`. | `{{ "2021-01-01T00:00:00Z" \| add_seconds:100.1 }}` |
+| add_seconds | Adds double seconds on valid [FHIR datetime](http://hl7.org/fhir/R4/datatypes.html) as input (e.g.2021-01-01T00:00:00Z ) and output a valid FHIR datetime. Provides parameters of double seconds to add and settings of time zones: `preserve`, `utc`, `local`. The default set of time zone parameter is `preserve`. | `{{ "2021-01-01T00:00:00Z" \| add_seconds:100.1, 'utc' }}` |


Adds double seconds on a valid FHIR datetime (e.g. 2021-01-01T00:00:00Z). Provides parameters to handle different time zones: preserve, utc, local. The default method is preserve.

ginalee-dotcom · 2022-03-29T19:06:07Z

docs/Filters-and-Tags.md

-| add_seconds | Adds double seconds on datetime in FHIR format. Provides parameters to set time zones: `preserve`, `utc`, `local`. The default is set to the parameter `preserve`. | `{{ "2021-01-01T00:00:00Z" \| add_seconds:100.1 }}` |
+| add_seconds | Adds double seconds on valid [FHIR datetime](http://hl7.org/fhir/R4/datatypes.html) as input (e.g.2021-01-01T00:00:00Z ) and output a valid FHIR datetime. Provides parameters of double seconds to add and settings of time zones: `preserve`, `utc`, `local`. The default set of time zone parameter is `preserve`. | `{{ "2021-01-01T00:00:00Z" \| add_seconds:100.1, 'utc' }}` |
+
+Examples:


DateTime filter usage examples:

yankunhuang-pku · 2022-04-06T05:15:42Z

@ginalee-dotcom @sowu880 Are we ready to merge this PR?

…fer/pgcritiques-merge * 'main' of github.com:microsoft/FHIR-Converter: Global Readiness Manifest file GeoPol.xml Update version (microsoft#375) Remove blank lines (microsoft#374) Update Doc for Filters (microsoft#365) Switch FormatAsDateTime timezone handling to preserve to maintain consistency (microsoft#358) Revert "reset to local (microsoft#368)" reset to local (microsoft#368) Phase -2, Milestone-3 Mapping (microsoft#366) Change Default Time Zone Handling (microsoft#363) Turn on mac functional test check (microsoft#367) Fix warnings (microsoft#364) Fix Time Zone Bug (microsoft#353) Phase2 - Milestone 1&2 Mapping (microsoft#354) Add check for large for loops (microsoft#361) Updated the logic of checking the number of default templates Update pipeline win host version (microsoft#359)

sowu880 and others added 6 commits October 27, 2021 21:07

Merge pull request #331 from microsoft/dotliquid

b7ca9ae

Create New Release 4.3.0

Merge pull request #337 from microsoft/dotliquid

85a0e9d

Create New Release 4.4.0

Update README.md for JSON to FHIR (#324)

ae582fa

* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update Filters-and-Tags.md * Update README.md * Update README.md * Update README.md

Merge pull request #347 from microsoft/dotliquid

b5d3adb

Release request

update

674dabd

update

d74b7e1

sowu880 requested review from BoyaWu10 and qiwjin March 22, 2022 07:50

BoyaWu10 reviewed Mar 22, 2022

View reviewed changes

update doc

ae500f4

ginalee-dotcom previously approved these changes Mar 29, 2022

View reviewed changes

update doc

32fc222

sowu880 dismissed ginalee-dotcom’s stale review via 32fc222 March 30, 2022 02:54

sowu880 requested a review from BoyaWu10 March 30, 2022 02:56

BoyaWu10 approved these changes Mar 30, 2022

View reviewed changes

qiwjin approved these changes Mar 30, 2022

View reviewed changes

sowu880 changed the base branch from main to dotliquid March 30, 2022 10:57

Merge branch 'dotliquid' into personal/sowu/update-filters-doc

68cd366

sowu880 merged commit 2a490b2 into dotliquid Apr 6, 2022

sowu880 deleted the personal/sowu/update-filters-doc branch April 6, 2022 06:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Doc for Filters #365

Update Doc for Filters #365

sowu880 commented Mar 22, 2022 •

edited

Loading

BoyaWu10 Mar 22, 2022

BoyaWu10 Mar 22, 2022

ginalee-dotcom Mar 29, 2022

ginalee-dotcom Mar 29, 2022

ginalee-dotcom Mar 29, 2022

ginalee-dotcom Mar 29, 2022

ginalee-dotcom Mar 29, 2022

yankunhuang-pku commented Apr 6, 2022 •

edited

Loading

Update Doc for Filters #365

Update Doc for Filters #365

Conversation

sowu880 commented Mar 22, 2022 • edited Loading

BoyaWu10 Mar 22, 2022

Choose a reason for hiding this comment

BoyaWu10 Mar 22, 2022

Choose a reason for hiding this comment

ginalee-dotcom Mar 29, 2022

Choose a reason for hiding this comment

ginalee-dotcom Mar 29, 2022

Choose a reason for hiding this comment

ginalee-dotcom Mar 29, 2022

Choose a reason for hiding this comment

ginalee-dotcom Mar 29, 2022

Choose a reason for hiding this comment

ginalee-dotcom Mar 29, 2022

Choose a reason for hiding this comment

yankunhuang-pku commented Apr 6, 2022 • edited Loading

sowu880 commented Mar 22, 2022 •

edited

Loading

yankunhuang-pku commented Apr 6, 2022 •

edited

Loading