Skip to content

Commit

Permalink
Cleanup operation defintions
Browse files Browse the repository at this point in the history
  • Loading branch information
bkaney committed Nov 8, 2023
1 parent a4bab1e commit a9243cb
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 19 deletions.
20 changes: 17 additions & 3 deletions input/fsh/operation-definitions/data-requirements-operation.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,7 @@ The version of the canonical resource to analyze
* parameter[=].documentation = """
A business identifier of the canonical resource to be analyzed.
"""
* parameter[=].type = #string
* parameter[=].searchType = #token
* parameter[=].type = #Identifier

* parameter[+].name = #expression
* parameter[=].use = #in
Expand Down Expand Up @@ -186,7 +185,22 @@ in the manifest library have the same meaning as specifying that code system or
canonical version in the `system-version` parameter of an expand or the `canonicalVersion`
parameter.
"""
* parameter[=].type = #uri
* parameter[=].type = #Library

* parameter[+].name = #manifestReference
* parameter[=].use = #in
* parameter[=].min = 0
* parameter[=].max = "1"
* parameter[=].documentation = """
Specifies a reference to an asset-collection library that defines version bindings for code
systems and other canonical resources referenced by the value set(s) being expanded
and other canonical resources referenced by the artifact. When specified, code
systems and other canonical resources identified as `depends-on` related artifacts
in the manifest library have the same meaning as specifying that code system or other
canonical version in the `system-version` parameter of an expand or the `canonicalVersion`
parameter.
"""
* parameter[=].type = #canonical

* parameter[+]
* name = #include
Expand Down
21 changes: 18 additions & 3 deletions input/fsh/operation-definitions/package-operation.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,7 @@ TODO: More documentation about the operation, including inline examples:
* min = 0
* max = "1"
* use = #in
* type = #string
* searchType = #token
* type = #Identifier
* documentation = "A business identifier of the Resource."

* parameter[+]
Expand Down Expand Up @@ -155,7 +154,7 @@ including code systems.
* min = 0
* max = "1"
* use = #in
* type = #uri
* type = #Library
* documentation = """
Specifies an asset-collection library that defines version bindings for code
systems and other canonical resources referenced by the value set(s) being expanded
Expand All @@ -166,6 +165,22 @@ canonical version in the `system-version` parameter of an expand or the `canonic
parameter.
"""

* parameter[+]
* name = #manifestReference
* min = 0
* max = "1"
* use = #in
* type = #canonical
* documentation = """
Specifies a reference to an asset-collection library that defines version
bindings for code systems and other canonical resources referenced by the value
set(s) being expanded and other canonical resources referenced by the artifact.
When specified, code systems and other canonical resources identified as
`depends-on` related artifacts in the manifest library have the same meaning as
specifying that code system or other canonical version in the `system-version`
parameter of an expand or the `canonicalVersion` parameter.
"""

* parameter[+]
* name = #offset
* min = 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ Rank each `artifactEndpointConfiguration` such that:

NOTE: For evenly ranked `artifactEndpointConfiguration`s, order as defined in the
OperationDefinition.

"""

* parameter
Expand Down
10 changes: 7 additions & 3 deletions input/fsh/operation-profiles/artifact-operation-profile.fsh
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
Invariant: crmi-artifact-operation-1
Description: "Parameter url type is uri or canonical"
Expression: "type='uri' or type='canonical'"
Severity: #error

Profile: ArtifactOperation
Id: crmi-artifact-operation
Parent: OperationDefinition
Expand Down Expand Up @@ -33,7 +38,7 @@ NOTE: When involking canonical operations using any combination of `url`,
* use = #in
* min = 0
* max = "1"
* type = #uri
* obeys crmi-artifact-operation-1

* parameter contains version 0..1 MS
* parameter[version]
Expand All @@ -49,8 +54,7 @@ NOTE: When involking canonical operations using any combination of `url`,
* use = #in
* min = 0
* max = "1"
* type = #string
* searchType = #token
* type = #Identifier

* parameter contains resource 0..1 MS
* parameter[resource]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ NOTE: This profile is here for backwards compatibility, see ArtifactVersionBinda
* min = 0
* max = "*"
* use = #in
* type = #uri
* type = #canonical

* parameter contains checkCanonicalVersion 0..* MS
* parameter[checkCanonicalVersion]
* name = #checkCanonicalVersion (exactly)
* min = 0
* max = "*"
* use = #in
* type = #uri
* type = #canonical

* parameter contains forceCanonicalVersion 0..* MS
* parameter[forceCanonicalVersion]
* name = #forceCanonicalVersion (exactly)
* min = 0
* max = "*"
* use = #in
* type = #uri
* type = #canonical
4 changes: 0 additions & 4 deletions input/fsh/operation-profiles/data-configurable-profile.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,11 @@ Operation where data endpoint configuration can be specified

* `useServerData`: Whether to use data from the server performing the evaluation, exclusive with `dataEndpoint`.
* `dataEndpoint`: An endpoint to use to access data referenced by retrieve operations in libraries, exclusive with `useServerData`.

"""

* parameter
* insert SliceOnName


// TODO: Add invariant to allow one or the other of the following:

* parameter contains useServerData 0..1 MS
* parameter[useServerData]
* name = #useServerData (exactly)
Expand Down
13 changes: 11 additions & 2 deletions input/fsh/operation-profiles/manifestable-operation-profile.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Description: """
Operation where default manifest to resolve canonicals can be specified

* `manifest`: Library resource where related-artifacts are used to define the versions of canonical resources.

* `manifestReference`: Canonical reference to existing manifest Library.
"""

* parameter
Expand All @@ -18,4 +18,13 @@ Operation where default manifest to resolve canonicals can be specified
* min = 0
* max = "1"
* use = #in
* type = #uri
* type = #Library

* parameter contains manifestReference 0..1 MS
* parameter[manifestReference]
* name = #manifestReference (exactly)
* min = 0
* max = "1"
* use = #in
* type = #canonical
* searchType = #reference

0 comments on commit a9243cb

Please sign in to comment.