add us core 3.1.1 ig

resources/uscore_v3.1.1/CodeSystem-careplan-category.json

@@ -0,0 +1 @@
+{"resourceType":"CodeSystem","id":"careplan-category","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system http://hl7.org/fhir/us/core/CodeSystem/careplan-category defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">assess-plan<a name=\"careplan-category-assess-plan\"> </a></td><td>Assessment and Plan of Treatment</td><td>The clinical conclusions and assumptions that guide the patient's treatment and the clinical activities formulated for a patient.</td></tr></table></div>"},"url":"http://hl7.org/fhir/us/core/CodeSystem/careplan-category","version":"3.1.1","name":"USCoreCarePlanCategoryExtensionCodes","title":"US Core CarePlan Category Extension Codes","status":"active","date":"2020-08-28T12:06:26+10:00","publisher":"HL7 US Realm Steering Committee","description":"Set of codes that are needed for implementation of the US-Core profiles. These codes are used as extensions to the FHIR and US Core value sets.\n","jurisdiction":[{"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}],"caseSensitive":true,"content":"complete","concept":[{"code":"assess-plan","display":"Assessment and Plan of Treatment","definition":"The clinical conclusions and assumptions that guide the patient's treatment and the clinical activities formulated for a patient."}]}

resources/uscore_v3.1.1/CodeSystem-condition-category.json

@@ -0,0 +1 @@
+{"resourceType":"CodeSystem","id":"condition-category","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Properties</b></p><table class=\"grid\"><tr><td><b>Code</b></td><td><b>URL</b></td><td><b>Description</b></td><td><b>Type</b></td></tr><tr><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>A property that indicates the status of the concept. One of active, experimental, deprecated,        retired</td><td>code</td></tr></table><p>This code system http://hl7.org/fhir/us/core/CodeSystem/condition-category defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>status</b></td></tr><tr><td style=\"white-space:nowrap\">problem<a name=\"condition-category-problem\"> </a></td><td>Problem</td><td>The patients problems as identified by the provider(s). Items on the provider’s problem list</td><td>deprecated</td></tr><tr><td style=\"white-space:nowrap\">health-concern<a name=\"condition-category-health-concern\"> </a></td><td>Health Concern</td><td>Additional health concerns from other stakeholders which are outside the provider’s problem list.</td><td/></tr></table></div>"},"url":"http://hl7.org/fhir/us/core/CodeSystem/condition-category","version":"3.1.1","name":"USCoreConditionCategoryExtensionCodes","title":"US Core Condition Category Extension Codes","status":"active","date":"2020-08-28T12:06:26+10:00","publisher":"HL7 US Realm Steering Committee","description":"Set of codes that are needed for implementation of the US-Core profiles. These codes are used as extensions to the FHIR and US Core value sets.\n","jurisdiction":[{"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}],"caseSensitive":true,"content":"complete","property":[{"code":"status","uri":"http://hl7.org/fhir/concept-properties#status","description":"A property that indicates the status of the concept. One of active, experimental, deprecated,        retired","type":"code"}],"concept":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/codesystem-replacedby","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/condition-category","code":"problem-list-item","display":"Problem List Item"}}],"code":"problem","display":"Problem","definition":"The patients problems as identified by the provider(s). Items on the provider’s problem list","property":[{"code":"status","valueCode":"deprecated"}]},{"code":"health-concern","display":"Health Concern","definition":"Additional health concerns from other stakeholders which are outside the provider’s problem list."}]}

resources/uscore_v3.1.1/CodeSystem-us-core-documentreference-category.json

@@ -0,0 +1 @@
+{"resourceType":"CodeSystem","id":"us-core-documentreference-category","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">clinical-note<a name=\"us-core-documentreference-category-clinical-note\"> </a></td><td>Clinical Note</td><td>Part of health record where healthcare professionals record details to document a patient's clinical status or achievements during the course of a hospitalization or over the course of outpatient care ([Wikipedia](https://en.wikipedia.org/wiki/Progress_note))</td></tr></table></div>"},"url":"http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category","version":"3.1.1","name":"USCoreDocumentReferencesCategoryCodes","title":"US Core DocumentReferences Category Codes","status":"active","date":"2019-05-21","description":"The US Core DocumentReferences Type Code System is a 'starter set' of categories supported for fetching and storing DocumentReference Resources.","jurisdiction":[{"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}],"caseSensitive":true,"valueSet":"http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category","content":"complete","count":2,"concept":[{"code":"clinical-note","display":"Clinical Note","definition":"Part of health record where healthcare professionals record details to document a patient's clinical status or achievements during the course of a hospitalization or over the course of outpatient care ([Wikipedia](https://en.wikipedia.org/wiki/Progress_note))"}]}

resources/uscore_v3.1.1/CodeSystem-us-core-provenance-participant-type.json

@@ -0,0 +1 @@
+{"resourceType":"CodeSystem","id":"us-core-provenance-participant-type","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">transmitter<a name=\"us-core-provenance-participant-type-transmitter\"> </a></td><td>Transmitter</td><td>The entity that provided the copy to your system.</td></tr></table></div>"},"url":"http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type","version":"3.1.1","name":"USCoreProvenancePaticipantTypeExtensionCodes","title":"US Core Provenance Participant Type Extension Codes","status":"active","date":"2020-08-28T12:06:26+10:00","publisher":"HL7 US Realm Steering Committee","description":"Set of codes that are needed for implementation of the US-Core profiles. These codes are used as extensions to the FHIR and US Core value sets.\n","jurisdiction":[{"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}],"caseSensitive":true,"content":"complete","concept":[{"code":"transmitter","display":"Transmitter","definition":"The entity that provided the copy to your system."}]}

resources/uscore_v3.1.1/OperationDefinition-docref.json

@@ -0,0 +1 @@
+{"resourceType":"OperationDefinition","id":"docref","text":{"status":"extensions","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>USCoreFetchDocumentReferences</h2><p>OPERATION: USCoreFetchDocumentReferences</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/core/OperationDefinition/docref</pre><div><p>This operation is used to return all the references to documents related to a patient.</p>\n<p>The operation takes the optional input parameters:</p>\n<ul>\n<li>patient id</li>\n<li>start date</li>\n<li>end date</li>\n<li>document type</li>\n</ul>\n<p>and returns a <a href=\"http://hl7.org/fhir/bundle.html\">Bundle</a> of type &quot;searchset&quot; containing <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference\">US Core DocumentReference Profiles</a> for the patient. If the server has or can create documents that are related to the patient, and that are available for the given user, the server returns the DocumentReference profiles needed to support the records.  The principle intended use for this operation is to provide a provider or patient with access to their available document information.</p>\n<p>This operation is <em>different</em> from a search by patient and type and date range because:</p>\n<ol>\n<li>\n<p>It is used to request a server <em>generate</em> a document based on the specified parameters.</p>\n</li>\n<li>\n<p>If no parameters are specified, the server SHALL return a DocumentReference to the patient's most current CCD</p>\n</li>\n<li>\n<p>If the server cannot <em>generate</em> a document based on the specified parameters, the operation will return an empty search bundle.</p>\n</li>\n</ol>\n<p>This operation is the <em>same</em> as a FHIR RESTful search by patient,type and date range because:</p>\n<ol>\n<li>References for <em>existing</em> documents that meet the requirements of the request SHOULD also be returned unless the client indicates they are only interested in 'on-demand' documents using the <em>on-demand</em> parameter.</li>\n</ol>\n</div><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#id\">id</a></td><td/><td><div><p>The id of the patient resource located on the server on which this operation is executed.  If there is no match, an empty Bundle is returned</p>\n</div></td></tr><tr><td>IN</td><td>start</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all documents prior to the end date are in scope.  If neither a start date nor an end date is provided, the most recent or current document is in scope.</p>\n</div></td></tr><tr><td>IN</td><td>end</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all documents subsequent to the start date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope</p>\n</div></td></tr><tr><td>IN</td><td>type</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td><a href=\"http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html\">http://hl7.org/fhir/ValueSet/c80-doc-typecodes</a> (Required)</td><td><div><p>The type relates to document type e.g. for the LOINC code for a C-CDA Clinical Summary of Care (CCD) is 34133-9 (Summary of episode note). If no type is provided, the CCD document, if available, SHALL be in scope and all other document types MAY be in scope</p>\n</div></td></tr><tr><td>IN</td><td>on-demand</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>This on-demand parameter allows client to dictate whether they are requesting only ‘on-demand’ or both ‘on-demand’ and 'stable' documents (or delayed/deferred assembly) that meet the query parameters</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The bundle type is &quot;searchset&quot;containing <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference\">US Core DocumentReference Profiles</a></p>\n</div></td></tr></table><div><ul>\n<li>\n<p>The server is responsible for determining what resources, if any, to return as <a href=\"http://hl7.org/fhir/R4/search.html#revinclude\">included</a> resources rather than the client specifying which ones. This frees the client from needing to determine what it could or should ask for. For example, the server may return the referenced document as an included FHIR Binary resource within the return bundle. The server's CapabilityStatement should document this behavior.</p>\n</li>\n<li>\n<p>The document itself can be subsequently retrieved using the link provided  in the <code>DocumentReference.content.attachment.url element</code>. The link could be a FHIR endpoint to a <a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a> Resource or some other document repository.</p>\n</li>\n<li>\n<p>It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification</p>\n</li>\n</ul>\n</div></div>"},"url":"http://hl7.org/fhir/us/core/OperationDefinition/docref","version":"3.1.1","name":"USCoreFetchDocumentReferences","title":"US Core Fetch DocumentReferences","status":"active","kind":"operation","date":"2019-05-21","publisher":"US Core Project","description":"This operation is used to return all the references to documents related to a patient. \n\n The operation takes the optional input parameters: \n  - patient id\n  - start date\n  - end date\n  - document type \n\n and returns a [Bundle](http://hl7.org/fhir/bundle.html) of type \"searchset\" containing [US Core DocumentReference Profiles](http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference) for the patient. If the server has or can create documents that are related to the patient, and that are available for the given user, the server returns the DocumentReference profiles needed to support the records.  The principle intended use for this operation is to provide a provider or patient with access to their available document information. \n\n This operation is *different* from a search by patient and type and date range because: \n\n 1. It is used to request a server *generate* a document based on the specified parameters. \n\n 1. If no parameters are specified, the server SHALL return a DocumentReference to the patient's most current CCD \n\n 1. If the server cannot *generate* a document based on the specified parameters, the operation will return an empty search bundle. \n\n This operation is the *same* as a FHIR RESTful search by patient,type and date range because: \n\n 1. References for *existing* documents that meet the requirements of the request SHOULD also be returned unless the client indicates they are only interested in 'on-demand' documents using the *on-demand* parameter.","jurisdiction":[{"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}],"code":"docref","comment":" - The server is responsible for determining what resources, if any, to return as [included](http://hl7.org/fhir/R4/search.html#revinclude) resources rather than the client specifying which ones. This frees the client from needing to determine what it could or should ask for. For example, the server may return the referenced document as an included FHIR Binary resource within the return bundle. The server's CapabilityStatement should document this behavior. \n\n - The document itself can be subsequently retrieved using the link provided  in the `DocumentReference.content.attachment.url element`. The link could be a FHIR endpoint to a [Binary](http://hl7.org/fhir/R4/binary.html) Resource or some other document repository. \n\n - It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification","system":false,"type":true,"instance":false,"parameter":[{"name":"patient","use":"in","min":1,"max":"1","documentation":"The id of the patient resource located on the server on which this operation is executed.  If there is no match, an empty Bundle is returned","type":"id"},{"name":"start","use":"in","min":0,"max":"1","documentation":"The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all documents prior to the end date are in scope.  If neither a start date nor an end date is provided, the most recent or current document is in scope.","type":"date"},{"name":"end","use":"in","min":0,"max":"1","documentation":"The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all documents subsequent to the start date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope","type":"date"},{"name":"type","use":"in","min":0,"max":"1","documentation":"The type relates to document type e.g. for the LOINC code for a C-CDA Clinical Summary of Care (CCD) is 34133-9 (Summary of episode note). If no type is provided, the CCD document, if available, SHALL be in scope and all other document types MAY be in scope","type":"CodeableConcept","binding":{"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/c80-doc-typecodes"}},{"name":"on-demand","use":"in","min":0,"max":"1","documentation":"This on-demand parameter allows client to dictate whether they are requesting only ‘on-demand’ or both ‘on-demand’ and 'stable' documents (or delayed/deferred assembly) that meet the query parameters","type":"boolean"},{"name":"return","use":"out","min":1,"max":"1","documentation":"The bundle type is \"searchset\"containing [US Core DocumentReference Profiles](http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference)","type":"Bundle"}]}