Skip to content

Commit 5e87308

Browse files
JohnMoehrkeJohnMoehrke
committed
fixup canonical URI to the new profiles.ihe.net
deprecate a QRPH code added IHE author instructions to the README.md
1 parent 9e822ab commit 5e87308

10 files changed

Lines changed: 112 additions & 22 deletions

‎README.md‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,35 @@ IG to manage the FormatCode vocabulary
33

44
continuous build available at http://build.fhir.org/ig/IHE/FormatCode/branches/master/index.html
55

6-
# TODO
6+
formal canonical URI http://profiles.ihe.net/fhir/iti.formatcode.fhir
7+
8+
formal publication URL http://profiles.ihe.net/fhir/iti.formatcode.fhir/index.html
9+
10+
# Instructions to IHE authors on requesting changes to the FormatCode vocabulary
11+
With the publication of the IHE FormatCode Implementation Guide (this content), the formal management of the IHE authored FormatCode vocabulary has moved. The previous wiki page is no longer formal, and will be retired.
12+
13+
Acceptable Changes:
14+
* Creation of a new code -- even experimental codes can be added. However the intention would be that the new code is intended to be a normative code. Thus please do not propose the addition of temporary, or project specific codes. The codes published here are formal publication of IHE.
15+
* Update of a code description
16+
* note that once a code has been used it must go through the proper code lifecycle. If a committee needs a code changed, this is accomplished by deprecating the old one and creating a new one
17+
* Deprecating a code
18+
19+
1. The committee that is requesting the change must hve formal governance approval for the change.
20+
2. The committee designated author (anyone with the authority of the committee) will prepare a GIT "Pull-Request"
21+
a. Edit the codesystem-formatcode.xml to add your new concepts
22+
b. Edit the codesystem-formatcode.xml date to the date of your edit
23+
c. Edit the provenance-IHE-formatcode.codesystem.xml to add a new Provenance record explaining the can
24+
* Indicate the dates of the change
25+
* Indicate the reason for the change
26+
* Indicate who the committee designated author is
27+
* Indicate what domain is the custodian of that code
28+
d. Edit the implementationguide-IHE.FormatCode.xml to update the date of this change, and version increment
29+
30+
If you have any problems, or need assistance contact JohnMoehrke@gmail.com or the assigned Librian of the FormatCode IG.
31+
32+
# TODO
733
* formal approval of this publication system (IG vs the wiki)
8-
* publish on IHE http://profiles.ihe.net/publications/FormatCode
34+
* publish on IHE http://profiles.ihe.net/ITI/FormatCode
935
* register this IG with fhir IG registry
1036
* register this vocabulary with fhir terminology
1137

‎ig.ini‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
[IG]
22
ig = input/implementationguide-IHE.FormatCode.xml
33
template = ihe.fhir.template#current
4+
#template = fhir.base.template

‎input/ignoreWarnings.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
== Suppressed Messages ==
22

33
# The following code systems are external and not supported by terminology server
4-
Error from server: Unable to provide support for code system http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode
4+
Error from server: Unable to provide support for code system http://profiles.ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode
55

66
# The following code system should eventually show up in the terminology server
77
Code System URI "http://terminology.hl7.org/CodeSystem/hl7-document-format-codes" is unknown so the code cannot be validated

‎input/implementationguide-IHE.FormatCode.xml‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ ImplementationGuide for <a href="https://wiki.ihe.net/index.php/IHE_Format_Code
99
</text>
1010
<!-- TODO: add once approval happens
1111
<extension url="http://hl7.org/fhir/StructureDefinition/resource-approvalDate">
12-
<valueDate value="2020-01-04"/>
12+
<valueDate value="2020-07-24"/>
1313
</extension>
1414
-->
15-
<url value="http://ihe.net/fhir/ihe.formatcode.fhir/ImplementationGuide/ihe.formatcode.fhir" />
16-
<version value="0.2.1" />
15+
<url value="http://profiles.ihe.net/fhir/ihe.formatcode.fhir/ImplementationGuide/ihe.formatcode.fhir" />
16+
<version value="0.2.2" />
1717
<name value="IHE_FORMATCODE" />
1818
<title value="IHE FormatCode Vocabulary" />
1919
<status value="active" />
2020
<experimental value="false" />
21-
<date value="2020-07-22" />
21+
<date value="2020-07-23" />
2222
<publisher value="Integrating the Healthcare Enterprise (IHE)" />
2323
<contact>
2424
<name value="IHE" />
@@ -62,6 +62,7 @@ ImplementationGuide for <a href="https://wiki.ihe.net/index.php/IHE_Format_Code
6262
<description value="A ValueSet of all the FormatCode code values assigned by IHE"/>
6363
<exampleBoolean value="false"/>
6464
</resource>
65+
<!-- TODO need to somehow add in the provenance history bundle -->
6566

6667
<page>
6768
<!-- The root will always be toc.html - the template will force it if you don't do it -->
@@ -89,7 +90,12 @@ ImplementationGuide for <a href="https://wiki.ihe.net/index.php/IHE_Format_Code
8990
<code value="releaselabel"/>
9091
<value value="CI Build"/>
9192
</parameter>
93+
<parameter>
94+
<code value="autoload-resources" />
95+
<value value="true" />
96+
</parameter>
97+
9298
</definition>
9399

94100

95-
</ImplementationGuide>
101+
</ImplementationGuide>

‎input/pagecontent/background.xml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,6 @@ As of December 2019, IHE and HL7 have worked together to transition the HL7 defi
2424
<a href="https://build.fhir.org/ig/HL7/UTG/index.html">HL7 CodeSystem</a>
2525
<code>http://terminology.hl7.org/CodeSystem/hl7-document-format-codes</code>
2626
</p>
27-
</div>
27+
<p>
28+
IHE co-chairs must follow the instructions for submitting change to the IHE FormatCode vocabulary as documented on the <a href="https://github.com/IHE/FormatCode">IHE GitHub repository for this FormatCode implementation guide</a>.</p>
29+
</div>

‎input/pagecontent/index.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<a name="intro"> </a>
44
<h3>Introduction</h3>
55
<p>
6-
This Implementation Guide publishes the IHE vocabulary for FormatCode and the IHE managed ValueSet for FormatCode
6+
This Implementation Guide publishes the IHE vocabulary for FormatCode and the IHE managed ValueSet for FormatCode. Given that the FormatCode is contriuted to by many IHE domains, this IG is dedicated to the publication and management of the FormatCode vocabulary.
77
</p>
88
<a name="technical"> </a>
99
<h3>Technical Overview</h3>
@@ -32,4 +32,4 @@
3232
The source code for this Implementation Guide can be found on <a href="https://github.com/IHE/FormatCode">IHE GitHub repository for FormatCode</a>
3333
</p>
3434

35-
</div>
35+
</div>

‎input/resources/codesystem-formatcode.xml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The actual list of codes is intended to be extensible.
2626
<title value="IHE Format Code set for use with Document Sharing"/>
2727
<status value="active"/>
2828
<experimental value="false"/>
29-
<date value="2020-07-03" />
29+
<date value="2020-07-23" />
3030
<publisher value="IHE"/>
3131
<contact>
3232
<name value="IHE"/>
@@ -801,6 +801,10 @@ The actual list of codes is intended to be extensible.
801801
<code value="comment"/>
802802
<valueString value="1.3.6.1.4.1.19376.1.7.3.1.1.21" />
803803
</property>
804+
<property>
805+
<code value="status"/>
806+
<valueCode value="deprecated"/>
807+
</property>
804808
</concept>
805809
<!-- not a FormatCode
806810
<concept>

‎input/resources/provenance-IHE-formatcode.codesystem.xml‎

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,63 @@
55
<type value="collection"/>
66
<!-- includes Provenance record for each revision of the IHE FormatCodes -->
77
<entry xmlns="http://hl7.org/fhir">
8-
<fullUrl value="http://ihe.net/fhir/ihe.formatcode.fhir/Provenance/20200703"/>
8+
<fullUrl value="http://profiles.ihe.net/fhir/ihe.formatcode.fhir/Provenance/20200723"/>
9+
<resource>
10+
<Provenance>
11+
<id value="formatcode-provenance-20200723"/>
12+
<target>
13+
<reference value="http://profiles.ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode"/>
14+
<type value="CodeSystem"/>
15+
</target>
16+
<occurredPeriod>
17+
<end value="2020-07-23"/>
18+
</occurredPeriod>
19+
<recorded value="2020-07-23T13:00:00.0000Z"/>
20+
<reason>
21+
<coding>
22+
<system value="http://terminology.hl7.org/CodeSystem/v3-ActReason"/>
23+
<code value="METAMGT"/>
24+
</coding>
25+
<text value="QRPH deprecated urn:ihe:qrph:crpc:2012."/>
26+
</reason>
27+
<activity>
28+
<coding>
29+
<system value="http://terminology.hl7.org/CodeSystem/v3-DataOperation"/>
30+
<code value="UPDATE"/>
31+
</coding>
32+
</activity>
33+
<agent>
34+
<type>
35+
<coding>
36+
<system value="http://terminology.hl7.org/CodeSystem/provenance-participant-type"/>
37+
<code value="author"/>
38+
</coding>
39+
</type>
40+
<who>
41+
<display value="John Moehrke"/>
42+
</who>
43+
</agent>
44+
<agent>
45+
<type>
46+
<coding>
47+
<system value="http://terminology.hl7.org/CodeSystem/provenance-participant-type"/>
48+
<code value="custodian"/>
49+
</coding>
50+
</type>
51+
<who>
52+
<display value="IHE QRPH Domain"/>
53+
</who>
54+
</agent>
55+
</Provenance>
56+
</resource>
57+
</entry>
58+
<entry xmlns="http://hl7.org/fhir">
59+
<fullUrl value="http://profiles.ihe.net/fhir/ihe.formatcode.fhir/Provenance/20200703"/>
960
<resource>
1061
<Provenance>
1162
<id value="formatcode-provenance-20200703"/>
1263
<target>
13-
<reference value="http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode"/>
64+
<reference value="http://profiles.ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode"/>
1465
<type value="CodeSystem"/>
1566
</target>
1667
<occurredPeriod>
@@ -56,12 +107,12 @@
56107
</resource>
57108
</entry>
58109
<entry>
59-
<fullUrl value="http://ihe.net/fhir/ihe.formatcode.fhir/Provenance/20200703-1"/>
110+
<fullUrl value="http://profiles.ihe.net/fhir/ihe.formatcode.fhir/Provenance/20200703-1"/>
60111
<resource>
61112
<Provenance>
62113
<id value="formatcode-provenance-20200701"/>
63114
<target>
64-
<reference value="http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode"/>
115+
<reference value="http://profiles.ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode"/>
65116
<type value="CodeSystem"/>
66117
</target>
67118
<occurredPeriod>
@@ -106,4 +157,4 @@
106157
</Provenance>
107158
</resource>
108159
</entry>
109-
</Bundle>
160+
</Bundle>

‎input/resources/valueset-formatcode.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<ValueSet xmlns="http://hl7.org/fhir">
33
<id value="formatcode" />
4-
<url value="http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode"/>
4+
<url value="http://profiles.ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode"/>
55
<identifier>
66
<system value="urn:ietf:rfc:3986"/>
77
<value value="urn:oid:1.3.6.1.4.1.19376.1.2.7.1"/>
88
</identifier>
9-
<version value="20200102"/>
9+
<version value="20200723"/>
1010
<name value="IHE_FormatCode_vs"/>
1111
<title value="IHE ValueSet of Format Codes for use with Document Sharing"/>
1212
<status value="active"/>
1313
<experimental value="false"/>
14-
<date value="2020-01-02" />
14+
<date value="2020-07-23" />
1515
<publisher value="IHE"/>
1616
<contact>
1717
<name value="IHE"/>
@@ -37,7 +37,7 @@
3737
<!-- must include using the FHIR defined URL, not the .identifier OID
3838
<system value="urn:oid:1.3.6.1.4.1.19376.1.2.3"/>
3939
-->
40-
<system value="http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode"/>
40+
<system value="http://profiles.ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode"/>
4141
<!-- note that by default a compose only brings in active codes, so deprecated are automatically not included -->
4242

4343
<!-- TODO: really want to put this in there so that the valueset does not include the ontology items, or other not selectable items

‎package-list.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"package-id" : "ihe.formatcode.fhir",
33
"title" : "IHE FormatCode Vocabulary",
4-
"canonical" : "http://ihe.net/fhir/ihe.formatcode.fhir/ImplementationGuide/ihe.formatcode.fhir",
4+
"canonical" : "http://profiles.ihe.net/fhir/ihe.formatcode.fhir/ImplementationGuide/ihe.formatcode.fhir",
55
"introduction" : "Implementation Guide for IHE defined FormatCode vocabulary.",
66
"list" : [{
77
"version" : "current",

0 commit comments

Comments
 (0)