@medplum/definitions 0.9.1 → 0.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,11 +1,19 @@
1
- # Medplum
2
-
3
- Medplum is a healthcare platform that helps you quickly develop high-quality compliant applications. Medplum includes a FHIR server, React component library, and developer app.
4
-
5
1
  # Medplum Data Definitions
6
2
 
7
3
  This package contains raw data definitions for a number of healthcare standards.
8
4
 
5
+ ## Installation
6
+
7
+ Add as a dependency:
8
+
9
+ ```bash
10
+ npm install @medplum/definitions
11
+ ```
12
+
13
+ ## About Medplum
14
+
15
+ Medplum is a healthcare platform that helps you quickly develop high-quality compliant applications. Medplum includes a FHIR server, React component library, and developer app.
16
+
9
17
  ## License
10
18
 
11
19
  Apache 2.0. Copyright © Medplum 2022
File without changes
@@ -614,9 +614,6 @@
614
614
  {
615
615
  "$ref": "#/definitions/Login"
616
616
  },
617
- {
618
- "$ref": "#/definitions/RefreshToken"
619
- },
620
617
  {
621
618
  "$ref": "#/definitions/PasswordChangeRequest"
622
619
  },
@@ -1086,9 +1083,6 @@
1086
1083
  {
1087
1084
  "$ref": "#/definitions/Login"
1088
1085
  },
1089
- {
1090
- "$ref": "#/definitions/RefreshToken"
1091
- },
1092
1086
  {
1093
1087
  "$ref": "#/definitions/PasswordChangeRequest"
1094
1088
  },
@@ -20732,6 +20726,13 @@
20732
20726
  "$ref": "#/definitions/DeviceDefinition_Material"
20733
20727
  },
20734
20728
  "type": "array"
20729
+ },
20730
+ "classification": {
20731
+ "description": "What kind of device or device system this is.",
20732
+ "items": {
20733
+ "$ref": "#/definitions/DeviceDefinition_Classification"
20734
+ },
20735
+ "type": "array"
20735
20736
  }
20736
20737
  },
20737
20738
  "additionalProperties": false,
@@ -21004,6 +21005,38 @@
21004
21005
  "substance"
21005
21006
  ]
21006
21007
  },
21008
+ "DeviceDefinition_Classification": {
21009
+ "description": "What kind of device or device system this is.",
21010
+ "properties": {
21011
+ "id": {
21012
+ "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
21013
+ "$ref": "#/definitions/string"
21014
+ },
21015
+ "extension": {
21016
+ "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
21017
+ "items": {
21018
+ "$ref": "#/definitions/Extension"
21019
+ },
21020
+ "type": "array"
21021
+ },
21022
+ "modifierExtension": {
21023
+ "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
21024
+ "items": {
21025
+ "$ref": "#/definitions/Extension"
21026
+ },
21027
+ "type": "array"
21028
+ },
21029
+ "type": {
21030
+ "description": "A classification or risk class of the device model.",
21031
+ "$ref": "#/definitions/CodeableConcept"
21032
+ },
21033
+ "justification": {
21034
+ "description": "Further information qualifying this classification of the device model.",
21035
+ "$ref": "#/definitions/RelatedArtifact"
21036
+ }
21037
+ },
21038
+ "additionalProperties": false
21039
+ },
21007
21040
  "DeviceMetric": {
21008
21041
  "description": "Describes a measurement, calculation or setting capability of a medical device.",
21009
21042
  "properties": {
@@ -61590,9 +61623,13 @@
61590
61623
  "$ref": "#/definitions/string"
61591
61624
  },
61592
61625
  "compartment": {
61593
- "description": "Optional compartment restriction for the resource type.",
61626
+ "description": "DEPRECATED Optional compartment restriction for the resource type.",
61594
61627
  "$ref": "#/definitions/Reference"
61595
61628
  },
61629
+ "criteria": {
61630
+ "description": "The rules that the server should use to determine which resources to allow.",
61631
+ "$ref": "#/definitions/string"
61632
+ },
61596
61633
  "readonly": {
61597
61634
  "description": "Optional flag to indicate that the resource type is read-only.",
61598
61635
  "$ref": "#/definitions/boolean"
@@ -1190,13 +1190,24 @@
1190
1190
  {
1191
1191
  "id" : "AccessPolicy.resource.compartment",
1192
1192
  "path" : "AccessPolicy.resource.compartment",
1193
- "definition" : "Optional compartment restriction for the resource type.",
1193
+ "definition" : "DEPRECATED Optional compartment restriction for the resource type.",
1194
1194
  "min" : 0,
1195
1195
  "max" : "1",
1196
1196
  "type" : [{
1197
1197
  "code" : "Reference"
1198
1198
  }]
1199
1199
  },
1200
+ {
1201
+ "id" : "AccessPolicy.resource.criteria",
1202
+ "path" : "AccessPolicy.resource.criteria",
1203
+ "definition" : "The rules that the server should use to determine which resources to allow.",
1204
+ "comment" : "The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".",
1205
+ "min" : 0,
1206
+ "max" : "1",
1207
+ "type" : [{
1208
+ "code" : "string"
1209
+ }]
1210
+ },
1200
1211
  {
1201
1212
  "id" : "AccessPolicy.resource.readonly",
1202
1213
  "path" : "AccessPolicy.resource.readonly",
@@ -125746,6 +125746,292 @@
125746
125746
  }],
125747
125747
  "isModifier" : false,
125748
125748
  "isSummary" : false
125749
+ },
125750
+ {
125751
+ "id" : "DeviceDefinition.classification",
125752
+ "path" : "DeviceDefinition.classification",
125753
+ "short" : "What kind of device or device system this is",
125754
+ "definition" : "What kind of device or device system this is.",
125755
+ "comment" : "In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.",
125756
+ "min" : 0,
125757
+ "max" : "*",
125758
+ "base" : {
125759
+ "path" : "DeviceDefinition.classification",
125760
+ "min" : 0,
125761
+ "max" : "*"
125762
+ },
125763
+ "type" : [
125764
+ {
125765
+ "code" : "BackboneElement"
125766
+ }
125767
+ ],
125768
+ "constraint" : [
125769
+ {
125770
+ "key" : "ele-1",
125771
+ "severity" : "error",
125772
+ "human" : "All FHIR elements must have a @value or children",
125773
+ "expression" : "hasValue() or (children().count() > id.count())",
125774
+ "xpath" : "@value|f:*|h:div",
125775
+ "source" : "http://hl7.org/fhir/StructureDefinition/Element"
125776
+ }
125777
+ ],
125778
+ "mustSupport" : false,
125779
+ "isModifier" : false,
125780
+ "isSummary" : false
125781
+ },
125782
+ {
125783
+ "id" : "DeviceDefinition.classification.id",
125784
+ "path" : "DeviceDefinition.classification.id",
125785
+ "representation" : [
125786
+ "xmlAttr"
125787
+ ],
125788
+ "short" : "Unique id for inter-element referencing",
125789
+ "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
125790
+ "min" : 0,
125791
+ "max" : "1",
125792
+ "base" : {
125793
+ "path" : "Element.id",
125794
+ "min" : 0,
125795
+ "max" : "1"
125796
+ },
125797
+ "type" : [
125798
+ {
125799
+ "extension" : [
125800
+ {
125801
+ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
125802
+ "valueUrl" : "id"
125803
+ }
125804
+ ],
125805
+ "code" : "http://hl7.org/fhirpath/System.String"
125806
+ }
125807
+ ],
125808
+ "isModifier" : false,
125809
+ "isSummary" : false,
125810
+ "mapping" : [
125811
+ {
125812
+ "identity" : "rim",
125813
+ "map" : "n/a"
125814
+ }
125815
+ ]
125816
+ },
125817
+ {
125818
+ "id" : "DeviceDefinition.classification.extension",
125819
+ "path" : "DeviceDefinition.classification.extension",
125820
+ "short" : "Additional content defined by implementations",
125821
+ "definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
125822
+ "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
125823
+ "alias" : [
125824
+ "extensions",
125825
+ "user content"
125826
+ ],
125827
+ "min" : 0,
125828
+ "max" : "*",
125829
+ "base" : {
125830
+ "path" : "Element.extension",
125831
+ "min" : 0,
125832
+ "max" : "*"
125833
+ },
125834
+ "type" : [
125835
+ {
125836
+ "code" : "Extension"
125837
+ }
125838
+ ],
125839
+ "constraint" : [
125840
+ {
125841
+ "key" : "ele-1",
125842
+ "severity" : "error",
125843
+ "human" : "All FHIR elements must have a @value or children",
125844
+ "expression" : "hasValue() or (children().count() > id.count())",
125845
+ "xpath" : "@value|f:*|h:div",
125846
+ "source" : "http://hl7.org/fhir/StructureDefinition/Element"
125847
+ },
125848
+ {
125849
+ "key" : "ext-1",
125850
+ "severity" : "error",
125851
+ "human" : "Must have either extensions or value[x], not both",
125852
+ "expression" : "extension.exists() != value.exists()",
125853
+ "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
125854
+ "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
125855
+ }
125856
+ ],
125857
+ "isModifier" : false,
125858
+ "isSummary" : false,
125859
+ "mapping" : [
125860
+ {
125861
+ "identity" : "rim",
125862
+ "map" : "n/a"
125863
+ }
125864
+ ]
125865
+ },
125866
+ {
125867
+ "id" : "DeviceDefinition.classification.modifierExtension",
125868
+ "path" : "DeviceDefinition.classification.modifierExtension",
125869
+ "short" : "Extensions that cannot be ignored even if unrecognized",
125870
+ "definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
125871
+ "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
125872
+ "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
125873
+ "alias" : [
125874
+ "extensions",
125875
+ "user content",
125876
+ "modifiers"
125877
+ ],
125878
+ "min" : 0,
125879
+ "max" : "*",
125880
+ "base" : {
125881
+ "path" : "BackboneElement.modifierExtension",
125882
+ "min" : 0,
125883
+ "max" : "*"
125884
+ },
125885
+ "type" : [
125886
+ {
125887
+ "code" : "Extension"
125888
+ }
125889
+ ],
125890
+ "constraint" : [
125891
+ {
125892
+ "key" : "ele-1",
125893
+ "severity" : "error",
125894
+ "human" : "All FHIR elements must have a @value or children",
125895
+ "expression" : "hasValue() or (children().count() > id.count())",
125896
+ "xpath" : "@value|f:*|h:div",
125897
+ "source" : "http://hl7.org/fhir/StructureDefinition/Element"
125898
+ },
125899
+ {
125900
+ "key" : "ext-1",
125901
+ "severity" : "error",
125902
+ "human" : "Must have either extensions or value[x], not both",
125903
+ "expression" : "extension.exists() != value.exists()",
125904
+ "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
125905
+ "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
125906
+ }
125907
+ ],
125908
+ "isModifier" : true,
125909
+ "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
125910
+ "isSummary" : true,
125911
+ "mapping" : [
125912
+ {
125913
+ "identity" : "rim",
125914
+ "map" : "N/A"
125915
+ }
125916
+ ]
125917
+ },
125918
+ {
125919
+ "id" : "DeviceDefinition.classification.type",
125920
+ "path" : "DeviceDefinition.classification.type",
125921
+ "short" : "A classification or risk class of the device model",
125922
+ "definition" : "A classification or risk class of the device model.",
125923
+ "min" : 1,
125924
+ "max" : "1",
125925
+ "base" : {
125926
+ "path" : "DeviceDefinition.classification.type",
125927
+ "min" : 1,
125928
+ "max" : "1"
125929
+ },
125930
+ "type" : [
125931
+ {
125932
+ "code" : "CodeableConcept"
125933
+ }
125934
+ ],
125935
+ "constraint" : [
125936
+ {
125937
+ "key" : "ele-1",
125938
+ "severity" : "error",
125939
+ "human" : "All FHIR elements must have a @value or children",
125940
+ "expression" : "hasValue() or (children().count() > id.count())",
125941
+ "xpath" : "@value|f:*|h:div",
125942
+ "source" : "http://hl7.org/fhir/StructureDefinition/Element"
125943
+ }
125944
+ ],
125945
+ "mustSupport" : false,
125946
+ "isModifier" : false,
125947
+ "isSummary" : false,
125948
+ "binding" : {
125949
+ "extension" : [
125950
+ {
125951
+ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
125952
+ "valueString" : "DeviceKind"
125953
+ }
125954
+ ],
125955
+ "strength" : "example",
125956
+ "description" : "Type of device e.g. according to official classification.",
125957
+ "valueSet" : "http://hl7.org/fhir/ValueSet/device-type"
125958
+ }
125959
+ },
125960
+ {
125961
+ "id" : "DeviceDefinition.classification.justification",
125962
+ "path" : "DeviceDefinition.classification.justification",
125963
+ "short" : "Further information qualifying this classification of the device model",
125964
+ "definition" : "Further information qualifying this classification of the device model.",
125965
+ "min" : 0,
125966
+ "max" : "*",
125967
+ "base" : {
125968
+ "path" : "DeviceDefinition.classification.justification",
125969
+ "min" : 0,
125970
+ "max" : "*"
125971
+ },
125972
+ "type" : [
125973
+ {
125974
+ "code" : "RelatedArtifact"
125975
+ }
125976
+ ],
125977
+ "constraint" : [
125978
+ {
125979
+ "key" : "ele-1",
125980
+ "severity" : "error",
125981
+ "human" : "All FHIR elements must have a @value or children",
125982
+ "expression" : "hasValue() or (children().count() > id.count())",
125983
+ "xpath" : "@value|f:*|h:div",
125984
+ "source" : "http://hl7.org/fhir/StructureDefinition/Element"
125985
+ }
125986
+ ],
125987
+ "mustSupport" : false,
125988
+ "isModifier" : false,
125989
+ "isSummary" : false
125990
+ },
125991
+ {
125992
+ "id" : "DeviceDefinition.bodySite",
125993
+ "path" : "DeviceDefinition.bodySite",
125994
+ "short" : "Target body site",
125995
+ "definition" : "Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).",
125996
+ "requirements" : "Knowing where the device is targeted is important for tracking if multiple sites are possible. If more information than just a code is required, use the extension [http://hl7.org/fhir/StructureDefinition/bodySite](extension-bodysite.html).",
125997
+ "min" : 0,
125998
+ "max" : "1",
125999
+ "base" : {
126000
+ "path" : "DeviceDefinition.bodySite",
126001
+ "min" : 0,
126002
+ "max" : "1"
126003
+ },
126004
+ "type" : [{
126005
+ "code" : "CodeableConcept"
126006
+ }],
126007
+ "constraint" : [{
126008
+ "key" : "ele-1",
126009
+ "severity" : "error",
126010
+ "human" : "All FHIR elements must have a @value or children",
126011
+ "expression" : "hasValue() or (children().count() > id.count())",
126012
+ "xpath" : "@value|f:*|h:div",
126013
+ "source" : "http://hl7.org/fhir/StructureDefinition/Element"
126014
+ }],
126015
+ "mustSupport" : false,
126016
+ "isModifier" : false,
126017
+ "isSummary" : true,
126018
+ "binding" : {
126019
+ "extension" : [{
126020
+ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
126021
+ "valueString" : "BodySite"
126022
+ }],
126023
+ "strength" : "example",
126024
+ "description" : "SNOMED CT Body site concepts",
126025
+ "valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
126026
+ },
126027
+ "mapping" : [{
126028
+ "identity" : "workflow",
126029
+ "map" : "Event.note"
126030
+ },
126031
+ {
126032
+ "identity" : "rim",
126033
+ "map" : "targetSiteCode"
126034
+ }]
125749
126035
  }]
125750
126036
  },
125751
126037
  "differential" : {
@@ -18088,6 +18088,43 @@
18088
18088
  "xpathUsage" : "normal"
18089
18089
  }
18090
18090
  },
18091
+ {
18092
+ "fullUrl" : "http://hl7.org/fhir/SearchParameter/DeviceDefinition-classification",
18093
+ "resource" : {
18094
+ "resourceType" : "SearchParameter",
18095
+ "id" : "DeviceDefinition-classification",
18096
+ "extension" : [{
18097
+ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
18098
+ "valueCode" : "trial-use"
18099
+ }],
18100
+ "url" : "http://hl7.org/fhir/SearchParameter/DeviceDefinition-classification",
18101
+ "version" : "5.0.0-snapshot1",
18102
+ "name" : "classification",
18103
+ "status" : "draft",
18104
+ "experimental" : false,
18105
+ "date" : "2021-12-19T08:15:41+11:00",
18106
+ "publisher" : "Health Level Seven International (Orders and Observations)",
18107
+ "contact" : [{
18108
+ "telecom" : [{
18109
+ "system" : "url",
18110
+ "value" : "http://hl7.org/fhir"
18111
+ }]
18112
+ },
18113
+ {
18114
+ "telecom" : [{
18115
+ "system" : "url",
18116
+ "value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
18117
+ }]
18118
+ }],
18119
+ "description" : "The device component classification",
18120
+ "code" : "classification",
18121
+ "base" : ["DeviceDefinition"],
18122
+ "type" : "token",
18123
+ "expression" : "DeviceDefinition.classification.type",
18124
+ "xpath" : "f:DeviceDefinition/f:classification/f:type",
18125
+ "xpathUsage" : "normal"
18126
+ }
18127
+ },
18091
18128
  {
18092
18129
  "fullUrl" : "http://hl7.org/fhir/SearchParameter/DeviceMetric-category",
18093
18130
  "resource" : {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@medplum/definitions",
3
- "version": "0.9.1",
3
+ "version": "0.9.4",
4
4
  "description": "Medplum Data Definitions",
5
5
  "author": "Medplum <hello@medplum.com>",
6
6
  "license": "Apache-2.0",