US Prescription Drug Monitoring Program (PDMP)
1.0.0-ballot - STU1 Ballot United States of America flag

US Prescription Drug Monitoring Program (PDMP), published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pdmp/ and changes regularly. See the Directory of published versions

Resource Profile: PDMP Parameters - Request

Official URL: http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-parameters-request Version: 1.0.0-ballot
Active as of 2024-04-01 Computable Name: PdmpParametersRequest
Other Identifiers: OID:2.16.840.1.113883.4.642.40.35.42.17

This profile tailors the Parameters resource to convey PDMP History operation inputs.

Example. This profile is illustrated in the following full message example:

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters Parameters
... Slices for parameter S 4..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:patient S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: patient
..... value[x] S 0..1 Reference(PDMP Patient) If parameter is a data type
.... parameter:animal-owner S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: animal-owner
..... value[x] S 0..1 Reference(US Core RelatedPerson Profile) If parameter is a data type
.... parameter:authorized-practitioner S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: authorized-practitioner
..... value[x] S 0..1 Reference(US Core Practitioner Profile) If parameter is a data type
.... parameter:authorized-practitioner-role S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: authorized-practitioner-role
..... value[x] 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:authorized-practitioner-organization S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: authorized-practitioner-organization
..... value[x] S 0..1 Reference(US Core Organization Profile) If parameter is a data type
.... parameter:delegate-practitioner S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: delegate-practitioner
..... value[x] S 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:delegate-practitioner-role S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: delegate-practitioner-role
..... value[x] 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:delegate-organization S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: delegate-organization
..... value[x] S 0..1 Reference(US Core Organization Profile) If parameter is a data type
.... parameter:pre-stage-only S 0..* BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: pre-stage-only
..... value[x] 0..1 boolean If parameter is a data type
.... parameter:pre-stage-retrieval-key S 0..* BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: pre-stage-retrieval-key
..... value[x] 0..1 string If parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter SΣC 4..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:patient SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: patient
..... value[x] SΣC 0..1 Reference(PDMP Patient) If parameter is a data type
.... parameter:animal-owner SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: animal-owner
..... value[x] SΣC 0..1 Reference(US Core RelatedPerson Profile) If parameter is a data type
.... parameter:authorized-practitioner SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner
..... value[x] SΣC 0..1 Reference(US Core Practitioner Profile) If parameter is a data type
.... parameter:authorized-practitioner-role SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner-role
..... value[x] ΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:authorized-practitioner-organization SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner-organization
..... value[x] SΣC 0..1 Reference(US Core Organization Profile) If parameter is a data type
.... parameter:delegate-practitioner SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-practitioner
..... value[x] SΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:delegate-practitioner-role SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-practitioner-role
..... value[x] ΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:delegate-organization SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-organization
..... value[x] SΣC 0..1 Reference(US Core Organization Profile) If parameter is a data type
.... parameter:pre-stage-only SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: pre-stage-only
..... value[x] ΣC 0..1 boolean If parameter is a data type
.... parameter:pre-stage-retrieval-key SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: pre-stage-retrieval-key
..... value[x] ΣC 0..1 string If parameter is a data type

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:patient, Parameters.parameter:animal-owner, Parameters.parameter:authorized-practitioner, Parameters.parameter:authorized-practitioner-role, Parameters.parameter:authorized-practitioner-organization, Parameters.parameter:delegate-practitioner, Parameters.parameter:delegate-practitioner-role, Parameters.parameter:delegate-organization, Parameters.parameter:pre-stage-only, Parameters.parameter:pre-stage-retrieval-keyA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter SΣC 4..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:patient SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: patient
..... value[x] SΣC 0..1 Reference(PDMP Patient) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:animal-owner SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: animal-owner
..... value[x] SΣC 0..1 Reference(US Core RelatedPerson Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:authorized-practitioner SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner
..... value[x] SΣC 0..1 Reference(US Core Practitioner Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:authorized-practitioner-role SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner-role
..... value[x] ΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:authorized-practitioner-organization SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner-organization
..... value[x] SΣC 0..1 Reference(US Core Organization Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:delegate-practitioner SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-practitioner
..... value[x] SΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:delegate-practitioner-role SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-practitioner-role
..... value[x] ΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:delegate-organization SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-organization
..... value[x] SΣC 0..1 Reference(US Core Organization Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:pre-stage-only SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: pre-stage-only
..... value[x] ΣC 0..1 boolean If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:pre-stage-retrieval-key SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: pre-stage-retrieval-key
..... value[x] ΣC 0..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:patient, Parameters.parameter:animal-owner, Parameters.parameter:authorized-practitioner, Parameters.parameter:authorized-practitioner-role, Parameters.parameter:authorized-practitioner-organization, Parameters.parameter:delegate-practitioner, Parameters.parameter:delegate-practitioner-role, Parameters.parameter:delegate-organization, Parameters.parameter:pre-stage-only, Parameters.parameter:pre-stage-retrieval-keyA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters Parameters
... Slices for parameter S 4..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:patient S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: patient
..... value[x] S 0..1 Reference(PDMP Patient) If parameter is a data type
.... parameter:animal-owner S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: animal-owner
..... value[x] S 0..1 Reference(US Core RelatedPerson Profile) If parameter is a data type
.... parameter:authorized-practitioner S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: authorized-practitioner
..... value[x] S 0..1 Reference(US Core Practitioner Profile) If parameter is a data type
.... parameter:authorized-practitioner-role S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: authorized-practitioner-role
..... value[x] 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:authorized-practitioner-organization S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: authorized-practitioner-organization
..... value[x] S 0..1 Reference(US Core Organization Profile) If parameter is a data type
.... parameter:delegate-practitioner S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: delegate-practitioner
..... value[x] S 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:delegate-practitioner-role S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: delegate-practitioner-role
..... value[x] 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:delegate-organization S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: delegate-organization
..... value[x] S 0..1 Reference(US Core Organization Profile) If parameter is a data type
.... parameter:pre-stage-only S 0..* BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: pre-stage-only
..... value[x] 0..1 boolean If parameter is a data type
.... parameter:pre-stage-retrieval-key S 0..* BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: pre-stage-retrieval-key
..... value[x] 0..1 string If parameter is a data type

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter SΣC 4..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:patient SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: patient
..... value[x] SΣC 0..1 Reference(PDMP Patient) If parameter is a data type
.... parameter:animal-owner SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: animal-owner
..... value[x] SΣC 0..1 Reference(US Core RelatedPerson Profile) If parameter is a data type
.... parameter:authorized-practitioner SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner
..... value[x] SΣC 0..1 Reference(US Core Practitioner Profile) If parameter is a data type
.... parameter:authorized-practitioner-role SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner-role
..... value[x] ΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:authorized-practitioner-organization SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner-organization
..... value[x] SΣC 0..1 Reference(US Core Organization Profile) If parameter is a data type
.... parameter:delegate-practitioner SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-practitioner
..... value[x] SΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:delegate-practitioner-role SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-practitioner-role
..... value[x] ΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
.... parameter:delegate-organization SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-organization
..... value[x] SΣC 0..1 Reference(US Core Organization Profile) If parameter is a data type
.... parameter:pre-stage-only SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: pre-stage-only
..... value[x] ΣC 0..1 boolean If parameter is a data type
.... parameter:pre-stage-retrieval-key SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: pre-stage-retrieval-key
..... value[x] ΣC 0..1 string If parameter is a data type

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:patient, Parameters.parameter:animal-owner, Parameters.parameter:authorized-practitioner, Parameters.parameter:authorized-practitioner-role, Parameters.parameter:authorized-practitioner-organization, Parameters.parameter:delegate-practitioner, Parameters.parameter:delegate-practitioner-role, Parameters.parameter:delegate-organization, Parameters.parameter:pre-stage-only, Parameters.parameter:pre-stage-retrieval-keyA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter SΣC 4..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:patient SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: patient
..... value[x] SΣC 0..1 Reference(PDMP Patient) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:animal-owner SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: animal-owner
..... value[x] SΣC 0..1 Reference(US Core RelatedPerson Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:authorized-practitioner SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner
..... value[x] SΣC 0..1 Reference(US Core Practitioner Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:authorized-practitioner-role SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner-role
..... value[x] ΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:authorized-practitioner-organization SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: authorized-practitioner-organization
..... value[x] SΣC 0..1 Reference(US Core Organization Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:delegate-practitioner SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-practitioner
..... value[x] SΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:delegate-practitioner-role SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-practitioner-role
..... value[x] ΣC 0..1 Reference(US Core PractitionerRole Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:delegate-organization SΣC 0..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: delegate-organization
..... value[x] SΣC 0..1 Reference(US Core Organization Profile) If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:pre-stage-only SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: pre-stage-only
..... value[x] ΣC 0..1 boolean If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:pre-stage-retrieval-key SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: pre-stage-retrieval-key
..... value[x] ΣC 0..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:patient, Parameters.parameter:animal-owner, Parameters.parameter:authorized-practitioner, Parameters.parameter:authorized-practitioner-role, Parameters.parameter:authorized-practitioner-organization, Parameters.parameter:delegate-practitioner, Parameters.parameter:delegate-practitioner-role, Parameters.parameter:delegate-organization, Parameters.parameter:pre-stage-only, Parameters.parameter:pre-stage-retrieval-keyA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))