Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B

8.29.12 Resource NutritionProduct - Search Parameters

Responsible Owner: Orders and Observations icon FHIR Infrastructure Work Group   Normative Maturity Level : N/A Standards Status Security Category : Informative Business Compartments : Not linked to any No defined compartments

Raw JSON Search parameters for the NutritionProduct resource. Also check the Extensions registry ( canonical form for search parameters on extensions related to this resource.

The common parameters + also see JSON Format Specification apply. See Searching ) for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/NutritionProduct-code

Generated Narrative: SearchParameter NutritionProduct-code

8.29.13 code

Operation Definition Parameter code : token

The code identifying a specific nutrition product

{ "resourceType" : "OperationDefinition", "id" : "Resource-validate", "text" : { "status" : "generated", "div" : "<div>!-- Snipped for Brevity --></div>" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 5 }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode" : "normative" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode" : "4.0.1" }], "url" : "http://hl7.org/fhir/OperationDefinition/Resource-validate", "version" : "4.0.1", "name" : "Validate a resource", "status" : "draft", "kind" : "operation", "date" : "2019-11-01T09:29:23+11:00", "publisher" : "HL7 (FHIR Project)", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://hl7.org/fhir" }, { "system" : "email", "value" : "fhir@lists.hl7.org" }] }], "description" : "The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: \n\n* [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules \n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) \n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) \n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) \n\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an [OperationOutcome](operationoutcome.html)\n\nNote that this operation is not the only way to validate resources - see [Validating Resources](validation.html) for further information.", "code" : "validate", "comment" : "This operation may be used during design and development to validate application design. It can also be used at run-time. One possible use might be that a client asks the server whether a proposed update is valid as the user is editing a dialog and displays an updated error to the user. The operation can be used as part of a light-weight two phase commit protocol but there is no expectation that the server will hold the content of the resource after this operation is used, or that the server guarantees to successfully perform an actual create, update or delete after the validation operation completes.\n\nThis operation returns a 200 OK whether or not the resource is valid. A 4xx or 5xx error means that the validation itself could not be performed, and it is unknown whether the resource is valid or not.\n\nNote: the correct behaviour of validation with regard to language (especially for Coding.display) is currently undefined, and further development and testing may lead to specific requirements or recommendations in subsequent releases\n\nFuture versions of this specifcation may add additional validation parameters. A candidate list is maintained with the [FHIR Validator Documentation](https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator)", "resource" : ["Resource"], "system" : false, "type" : true, "instance" : true, "parameter" : [{ "name" : "resource", "use" : "in", "min" : 0, "max" : "1", "documentation" : "Must be present unless the mode is \"delete\"", "type" : "Resource" }, { "name" : "mode", "use" : "in", "min" : 0, "max" : "1", "documentation" : "Default is 'no action'; (e.g. general validation)", "type" : "code", "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/fhir/ValueSet/resource-validation-mode|4.0.1" } }, { "name" : "profile", "use" : "in", "min" : 0, "max" : "1", "documentation" : "If this is nominated, then the resource is validated against this specific profile. If a profile is nominated, and the server cannot validate against the nominated profile, it SHALL return an error", "type" : "uri" }, { "name" : "return", "use" : "out", "min" : 1, "max" : "1", "documentation" : "If the operation outcome does not list any errors, and a mode was specified, then this is an indication that the operation would be expected to succeed (excepting for transactional integrity issues, see below)", "type" : "OperationOutcome" }] }
Resource NutritionProduct
Expression NutritionProduct.code
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/NutritionProduct-expiration-date

Generated Narrative: SearchParameter NutritionProduct-expiration-date

8.29.14 expiration-date

Usage note: every effort has been made Parameter expiration-date : date

When the product expired (or is expected to ensure expire)

Resource NutritionProduct
Expression NutritionProduct.instance.expiry
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the examples are correct and useful, but they are not server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/NutritionProduct-identifier

Generated Narrative: SearchParameter NutritionProduct-identifier

8.29.15 identifier

Parameter identifier : token

The identifier for the physical instance, typically a normative part serial number

Resource NutritionProduct
Expression NutritionProduct.instance.identifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/NutritionProduct-ingredient-item

Generated Narrative: SearchParameter NutritionProduct-ingredient-item

8.29.16 ingredient-item

Parameter ingredient-item : token

The specific ingredient

Resource NutritionProduct
Expression NutritionProduct.ingredient.item.concept
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/NutritionProduct-lot-number

Generated Narrative: SearchParameter NutritionProduct-lot-number

8.29.17 lot-number

Parameter lot-number : token

The lot number

Resource NutritionProduct
Expression NutritionProduct.instance.lotNumber
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/NutritionProduct-serial-number

Generated Narrative: SearchParameter NutritionProduct-serial-number

8.29.18 serial-number

Parameter serial-number : token

The serial number

Resource NutritionProduct
Expression NutritionProduct.instance.identifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/NutritionProduct-status

Generated Narrative: SearchParameter NutritionProduct-status

8.29.19 status

Parameter status : token

The broad product group or category of the specification. nutrition product

Resource NutritionProduct
Expression NutritionProduct.category
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true