Resource Profile: Parameters_SPOClinicalInformationRequest_LatestClinicalNoteQuery
This profile sets the expectations for the Parameters resource. It identifies the mandatory core elements, extensions, vocabularies, and value sets which SHALL be present in the Parameters as well as optional elements when using this profile.
This Parameters profile defines the parameters that specify a query (request) for the most recent clinical note for a specific patient. The data should be returned as a DocumentReference resource.
Example
Formal View of Profile Content
This profile builds on Parameters. For additional information on the table definitions shown below, see the Logical Table section on the Resource Formats page.
Notes: Click the tabs below to see the different views for the profile:
- The Full View shows all the base resource element information for the profile plus the Surescripts requirements.
- The Hybrid View shows all the element information, but the unchanged information from the base resource is greyed out.
- The Differential View only shows the changes made to the base resource (i.e., the Surescripts requirements).
Full View
Parameters | Parameters | There are no (further) constraints on this element Element IdParameters Operation Request or Response DefinitionThis resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. The parameters that may be used are defined by the OperationDefinition resource.
| ||
parameter | S Σ I | 7..7 | BackboneElement | Element IdParameters.parameter Operation Parameter DefinitionThe parameters for requesting the most recent clinical note for a patient. Unordered, Open, by name(Value) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
name | Σ | 1..1 | string | There are no (further) constraints on this element Element IdParameters.parameter.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1MB in size
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdParameters.parameter.value[x] If parameter is a data type DefinitionIf the parameter is a data type.
| |
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueCanonical | canonical() | There are no (further) constraints on this element Data Type | ||
valueCode | code | There are no (further) constraints on this element Data Type | ||
valueDate | date | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data Type | ||
valueId | id | There are no (further) constraints on this element Data Type | ||
valueInstant | instant | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data Type | ||
valueOid | oid | There are no (further) constraints on this element Data Type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data Type | ||
valueUri | uri | There are no (further) constraints on this element Data Type | ||
valueUrl | url | There are no (further) constraints on this element Data Type | ||
valueUuid | uuid | There are no (further) constraints on this element Data Type | ||
valueAddress | Address | There are no (further) constraints on this element Data Type | ||
valueAge | Age | There are no (further) constraints on this element Data Type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data Type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data Type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueCoding | Coding | There are no (further) constraints on this element Data Type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data Type | ||
valueCount | Count | There are no (further) constraints on this element Data Type | ||
valueDistance | Distance | There are no (further) constraints on this element Data Type | ||
valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data Type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data Type | ||
valueMoney | Money | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueSignature | Signature | There are no (further) constraints on this element Data Type | ||
valueTiming | Timing | There are no (further) constraints on this element Data Type | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data Type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data Type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data Type | ||
valueExpression | Expression | There are no (further) constraints on this element Data Type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data Type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data Type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data Type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data Type | ||
valueDosage | Dosage | There are no (further) constraints on this element Data Type | ||
valueMeta | Meta | There are no (further) constraints on this element Data Type | ||
valueReference | Reference() | There are no (further) constraints on this element Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
resourceType | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:resourceType Parameter for resource type DefinitionThe parameter that defines the type of resource being queried.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:resourceType.name Parameter name DefinitionThe name of the parameter. Note that FHIR strings SHALL NOT exceed 1MB in size
ResourceType
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:resourceType.value[x] Resource type name DefinitionThe name of the resource type (DocumentReference) to return for a clinical note.
DocumentReference
|
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:resourceType.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:resourceType.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
medicalRecordNumber | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:medicalRecordNumber Parameter for patient Medical Record Number DefinitionThis parameter defines the Medical Record Number for whom data is being queried.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:medicalRecordNumber.name Parameter name DefinitionThe name of the parameter. Note that FHIR strings SHALL NOT exceed 1MB in size
PatientMrn
|
value[x] | S Σ I | 1..1 | Element IdParameters.parameter:medicalRecordNumber.value[x] Medical Record Number DefinitionThe Medical Record Number of the patient for whom data is requested.
| |
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumber.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumber.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
medicalRecordNumberMutuallyDefined | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:medicalRecordNumberMutuallyDefined This parameter ties back to the Patient/Identification/MutuallyDefined field from the SPOInitiationRequest. If that optional field was populated, the value will display here as well. If not, this value will be null. DefinitionThis parameter specifies a medical record qualifier to make a patient MRN globally unique (when necessary). This parameter ties back to the Patient/Identification/MutuallyDefined field from the SPOInitiationRequest. If that optional field was populated, the value will display here as well. If not, this value will be null.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.name Parameter name DefinitionThe name of the parameter for the patient's medical record number qualifier. Note that FHIR strings SHALL NOT exceed 1MB in size
MutuallyDefined
|
value[x] | S Σ I | 1..1 | Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.value[x] Medical record number qualifier value DefinitionThe value of the medical record number qualifier for the patient's medical record number.
| |
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
prescriberNPI | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:prescriberNPI Parameter to specify a National Provider Identifier DefinitionThe name of the parameter for the National Provider Identifier for a prescriber.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:prescriberNPI.name Parameter name DefinitionThe name of the parameter for the National Provider Identifier for a prescriber. Note that FHIR strings SHALL NOT exceed 1MB in size
PrescriberNPI
|
value[x] | S Σ I | 1..1 | Element IdParameters.parameter:prescriberNPI.value[x] The National Provider Identifier value DefinitionThe National Provider Identifier of the prescriber.
| |
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:prescriberNPI.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:prescriberNPI.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
clinicalNoteLOINCs | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:clinicalNoteLOINCs Parameter to specify the LOINC values that represent a clinical note DefinitionThis parameter defines the LOINC values that represent a clinical note.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:clinicalNoteLOINCs.name Parameter name DefinitionThe name of the parameter for the clinical note LOINCs. Note that FHIR strings SHALL NOT exceed 1MB in size
ClinicalNoteLOINCs
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:clinicalNoteLOINCs.value[x] LOINCs representing clinical notes DefinitionThe LOINC values that represent a clinical note.
{ "coding": [ { "system": "http://loinc.org", "code": "11506-3", "display": "Progress note" }, { "system": "http://loinc.org", "code": "11488-4", "display": "Consult note" }, { "system": "http://loinc.org", "code": "34748-4", "display": "Telephone encounter Note" }, { "system": "http://loinc.org", "code": "34117-2", "display": "History & Physical" } ] }
|
valueCodeableConcept | CodeableConcept | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:clinicalNoteLOINCs.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:clinicalNoteLOINCs.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
statusDocumentReference | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:statusDocumentReference Parameter to specify the allowed value for DocumentReference status DefinitionThis parameter defines the allowed value for DocumentReference.status (active).
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:statusDocumentReference.name Parameter name DefinitionThe name of the parameter for defining the acceptable value for the DocumentReference.status property Note that FHIR strings SHALL NOT exceed 1MB in size
status
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:statusDocumentReference.value[x] The valid value for DocumentReference status DefinitionThe value that is valid for the DocumentReference.status property (current).
current
|
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:statusDocumentReference.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:statusDocumentReference.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
latestQueryOperator | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:latestQueryOperator Parameter to specify the query parameter for requesting the most recent value DefinitionThis parameter specifies the query parameter to request the most recent value.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:latestQueryOperator.name Parameter name DefinitionThe name of the parameter for the query operator. Note that FHIR strings SHALL NOT exceed 1MB in size
QueryOperator
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:latestQueryOperator.value[x] The value of the query operator parameter (lastn) DefinitionThe value of the query operator parameter (lastn).
lastn
|
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:latestQueryOperator.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:latestQueryOperator.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
Hybrid View
Parameters | Parameters | There are no (further) constraints on this element Element IdParameters Operation Request or Response DefinitionThis resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. The parameters that may be used are defined by the OperationDefinition resource.
| ||
parameter | S Σ I | 7..7 | BackboneElement | Element IdParameters.parameter Operation Parameter DefinitionThe parameters for requesting the most recent clinical note for a patient. Unordered, Open, by name(Value) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
name | Σ | 1..1 | string | There are no (further) constraints on this element Element IdParameters.parameter.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1MB in size
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdParameters.parameter.value[x] If parameter is a data type DefinitionIf the parameter is a data type.
| |
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueCanonical | canonical() | There are no (further) constraints on this element Data Type | ||
valueCode | code | There are no (further) constraints on this element Data Type | ||
valueDate | date | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data Type | ||
valueId | id | There are no (further) constraints on this element Data Type | ||
valueInstant | instant | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data Type | ||
valueOid | oid | There are no (further) constraints on this element Data Type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data Type | ||
valueUri | uri | There are no (further) constraints on this element Data Type | ||
valueUrl | url | There are no (further) constraints on this element Data Type | ||
valueUuid | uuid | There are no (further) constraints on this element Data Type | ||
valueAddress | Address | There are no (further) constraints on this element Data Type | ||
valueAge | Age | There are no (further) constraints on this element Data Type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data Type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data Type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueCoding | Coding | There are no (further) constraints on this element Data Type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data Type | ||
valueCount | Count | There are no (further) constraints on this element Data Type | ||
valueDistance | Distance | There are no (further) constraints on this element Data Type | ||
valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data Type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data Type | ||
valueMoney | Money | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueSignature | Signature | There are no (further) constraints on this element Data Type | ||
valueTiming | Timing | There are no (further) constraints on this element Data Type | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data Type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data Type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data Type | ||
valueExpression | Expression | There are no (further) constraints on this element Data Type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data Type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data Type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data Type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data Type | ||
valueDosage | Dosage | There are no (further) constraints on this element Data Type | ||
valueMeta | Meta | There are no (further) constraints on this element Data Type | ||
valueReference | Reference() | There are no (further) constraints on this element Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
resourceType | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:resourceType Parameter for resource type DefinitionThe parameter that defines the type of resource being queried.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:resourceType.name Parameter name DefinitionThe name of the parameter. Note that FHIR strings SHALL NOT exceed 1MB in size
ResourceType
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:resourceType.value[x] Resource type name DefinitionThe name of the resource type (DocumentReference) to return for a clinical note.
DocumentReference
|
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:resourceType.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:resourceType.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
medicalRecordNumber | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:medicalRecordNumber Parameter for patient Medical Record Number DefinitionThis parameter defines the Medical Record Number for whom data is being queried.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:medicalRecordNumber.name Parameter name DefinitionThe name of the parameter. Note that FHIR strings SHALL NOT exceed 1MB in size
PatientMrn
|
value[x] | S Σ I | 1..1 | Element IdParameters.parameter:medicalRecordNumber.value[x] Medical Record Number DefinitionThe Medical Record Number of the patient for whom data is requested.
| |
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumber.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumber.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
medicalRecordNumberMutuallyDefined | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:medicalRecordNumberMutuallyDefined This parameter ties back to the Patient/Identification/MutuallyDefined field from the SPOInitiationRequest. If that optional field was populated, the value will display here as well. If not, this value will be null. DefinitionThis parameter specifies a medical record qualifier to make a patient MRN globally unique (when necessary). This parameter ties back to the Patient/Identification/MutuallyDefined field from the SPOInitiationRequest. If that optional field was populated, the value will display here as well. If not, this value will be null.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.name Parameter name DefinitionThe name of the parameter for the patient's medical record number qualifier. Note that FHIR strings SHALL NOT exceed 1MB in size
MutuallyDefined
|
value[x] | S Σ I | 1..1 | Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.value[x] Medical record number qualifier value DefinitionThe value of the medical record number qualifier for the patient's medical record number.
| |
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
prescriberNPI | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:prescriberNPI Parameter to specify a National Provider Identifier DefinitionThe name of the parameter for the National Provider Identifier for a prescriber.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:prescriberNPI.name Parameter name DefinitionThe name of the parameter for the National Provider Identifier for a prescriber. Note that FHIR strings SHALL NOT exceed 1MB in size
PrescriberNPI
|
value[x] | S Σ I | 1..1 | Element IdParameters.parameter:prescriberNPI.value[x] The National Provider Identifier value DefinitionThe National Provider Identifier of the prescriber.
| |
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:prescriberNPI.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:prescriberNPI.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
clinicalNoteLOINCs | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:clinicalNoteLOINCs Parameter to specify the LOINC values that represent a clinical note DefinitionThis parameter defines the LOINC values that represent a clinical note.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:clinicalNoteLOINCs.name Parameter name DefinitionThe name of the parameter for the clinical note LOINCs. Note that FHIR strings SHALL NOT exceed 1MB in size
ClinicalNoteLOINCs
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:clinicalNoteLOINCs.value[x] LOINCs representing clinical notes DefinitionThe LOINC values that represent a clinical note.
{ "coding": [ { "system": "http://loinc.org", "code": "11506-3", "display": "Progress note" }, { "system": "http://loinc.org", "code": "11488-4", "display": "Consult note" }, { "system": "http://loinc.org", "code": "34748-4", "display": "Telephone encounter Note" }, { "system": "http://loinc.org", "code": "34117-2", "display": "History & Physical" } ] }
|
valueCodeableConcept | CodeableConcept | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:clinicalNoteLOINCs.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:clinicalNoteLOINCs.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
statusDocumentReference | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:statusDocumentReference Parameter to specify the allowed value for DocumentReference status DefinitionThis parameter defines the allowed value for DocumentReference.status (active).
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:statusDocumentReference.name Parameter name DefinitionThe name of the parameter for defining the acceptable value for the DocumentReference.status property Note that FHIR strings SHALL NOT exceed 1MB in size
status
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:statusDocumentReference.value[x] The valid value for DocumentReference status DefinitionThe value that is valid for the DocumentReference.status property (current).
current
|
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:statusDocumentReference.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:statusDocumentReference.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
latestQueryOperator | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:latestQueryOperator Parameter to specify the query parameter for requesting the most recent value DefinitionThis parameter specifies the query parameter to request the most recent value.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:latestQueryOperator.name Parameter name DefinitionThe name of the parameter for the query operator. Note that FHIR strings SHALL NOT exceed 1MB in size
QueryOperator
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:latestQueryOperator.value[x] The value of the query operator parameter (lastn) DefinitionThe value of the query operator parameter (lastn).
lastn
|
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:latestQueryOperator.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:latestQueryOperator.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
Differential View
Parameters | Parameters | There are no (further) constraints on this element Element IdParameters Operation Request or Response DefinitionThis resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. The parameters that may be used are defined by the OperationDefinition resource.
| ||
parameter | S Σ I | 7..7 | BackboneElement | Element IdParameters.parameter Operation Parameter DefinitionThe parameters for requesting the most recent clinical note for a patient. Unordered, Open, by name(Value) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
name | Σ | 1..1 | string | There are no (further) constraints on this element Element IdParameters.parameter.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1MB in size
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element IdParameters.parameter.value[x] If parameter is a data type DefinitionIf the parameter is a data type.
| |
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data Type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
valueCanonical | canonical() | There are no (further) constraints on this element Data Type | ||
valueCode | code | There are no (further) constraints on this element Data Type | ||
valueDate | date | There are no (further) constraints on this element Data Type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data Type | ||
valueId | id | There are no (further) constraints on this element Data Type | ||
valueInstant | instant | There are no (further) constraints on this element Data Type | ||
valueInteger | integer | There are no (further) constraints on this element Data Type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data Type | ||
valueOid | oid | There are no (further) constraints on this element Data Type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data Type | ||
valueString | string | There are no (further) constraints on this element Data Type | ||
valueTime | time | There are no (further) constraints on this element Data Type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data Type | ||
valueUri | uri | There are no (further) constraints on this element Data Type | ||
valueUrl | url | There are no (further) constraints on this element Data Type | ||
valueUuid | uuid | There are no (further) constraints on this element Data Type | ||
valueAddress | Address | There are no (further) constraints on this element Data Type | ||
valueAge | Age | There are no (further) constraints on this element Data Type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data Type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data Type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
valueCoding | Coding | There are no (further) constraints on this element Data Type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data Type | ||
valueCount | Count | There are no (further) constraints on this element Data Type | ||
valueDistance | Distance | There are no (further) constraints on this element Data Type | ||
valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data Type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data Type | ||
valueMoney | Money | There are no (further) constraints on this element Data Type | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data Type | ||
valueRange | Range | There are no (further) constraints on this element Data Type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
valueSignature | Signature | There are no (further) constraints on this element Data Type | ||
valueTiming | Timing | There are no (further) constraints on this element Data Type | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data Type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data Type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data Type | ||
valueExpression | Expression | There are no (further) constraints on this element Data Type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data Type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data Type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data Type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data Type | ||
valueDosage | Dosage | There are no (further) constraints on this element Data Type | ||
valueMeta | Meta | There are no (further) constraints on this element Data Type | ||
valueReference | Reference() | There are no (further) constraints on this element Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
resourceType | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:resourceType Parameter for resource type DefinitionThe parameter that defines the type of resource being queried.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:resourceType.name Parameter name DefinitionThe name of the parameter. Note that FHIR strings SHALL NOT exceed 1MB in size
ResourceType
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:resourceType.value[x] Resource type name DefinitionThe name of the resource type (DocumentReference) to return for a clinical note.
DocumentReference
|
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:resourceType.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:resourceType.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
medicalRecordNumber | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:medicalRecordNumber Parameter for patient Medical Record Number DefinitionThis parameter defines the Medical Record Number for whom data is being queried.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:medicalRecordNumber.name Parameter name DefinitionThe name of the parameter. Note that FHIR strings SHALL NOT exceed 1MB in size
PatientMrn
|
value[x] | S Σ I | 1..1 | Element IdParameters.parameter:medicalRecordNumber.value[x] Medical Record Number DefinitionThe Medical Record Number of the patient for whom data is requested.
| |
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumber.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumber.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
medicalRecordNumberMutuallyDefined | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:medicalRecordNumberMutuallyDefined This parameter ties back to the Patient/Identification/MutuallyDefined field from the SPOInitiationRequest. If that optional field was populated, the value will display here as well. If not, this value will be null. DefinitionThis parameter specifies a medical record qualifier to make a patient MRN globally unique (when necessary). This parameter ties back to the Patient/Identification/MutuallyDefined field from the SPOInitiationRequest. If that optional field was populated, the value will display here as well. If not, this value will be null.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.name Parameter name DefinitionThe name of the parameter for the patient's medical record number qualifier. Note that FHIR strings SHALL NOT exceed 1MB in size
MutuallyDefined
|
value[x] | S Σ I | 1..1 | Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.value[x] Medical record number qualifier value DefinitionThe value of the medical record number qualifier for the patient's medical record number.
| |
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:medicalRecordNumberMutuallyDefined.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
prescriberNPI | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:prescriberNPI Parameter to specify a National Provider Identifier DefinitionThe name of the parameter for the National Provider Identifier for a prescriber.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:prescriberNPI.name Parameter name DefinitionThe name of the parameter for the National Provider Identifier for a prescriber. Note that FHIR strings SHALL NOT exceed 1MB in size
PrescriberNPI
|
value[x] | S Σ I | 1..1 | Element IdParameters.parameter:prescriberNPI.value[x] The National Provider Identifier value DefinitionThe National Provider Identifier of the prescriber.
| |
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:prescriberNPI.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:prescriberNPI.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
clinicalNoteLOINCs | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:clinicalNoteLOINCs Parameter to specify the LOINC values that represent a clinical note DefinitionThis parameter defines the LOINC values that represent a clinical note.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:clinicalNoteLOINCs.name Parameter name DefinitionThe name of the parameter for the clinical note LOINCs. Note that FHIR strings SHALL NOT exceed 1MB in size
ClinicalNoteLOINCs
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:clinicalNoteLOINCs.value[x] LOINCs representing clinical notes DefinitionThe LOINC values that represent a clinical note.
{ "coding": [ { "system": "http://loinc.org", "code": "11506-3", "display": "Progress note" }, { "system": "http://loinc.org", "code": "11488-4", "display": "Consult note" }, { "system": "http://loinc.org", "code": "34748-4", "display": "Telephone encounter Note" }, { "system": "http://loinc.org", "code": "34117-2", "display": "History & Physical" } ] }
|
valueCodeableConcept | CodeableConcept | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:clinicalNoteLOINCs.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:clinicalNoteLOINCs.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
statusDocumentReference | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:statusDocumentReference Parameter to specify the allowed value for DocumentReference status DefinitionThis parameter defines the allowed value for DocumentReference.status (active).
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:statusDocumentReference.name Parameter name DefinitionThe name of the parameter for defining the acceptable value for the DocumentReference.status property Note that FHIR strings SHALL NOT exceed 1MB in size
status
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:statusDocumentReference.value[x] The valid value for DocumentReference status DefinitionThe value that is valid for the DocumentReference.status property (current).
current
|
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:statusDocumentReference.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:statusDocumentReference.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
latestQueryOperator | S Σ I | 1..1 | BackboneElement | Element IdParameters.parameter:latestQueryOperator Parameter to specify the query parameter for requesting the most recent value DefinitionThis parameter specifies the query parameter to request the most recent value.
|
name | S Σ | 1..1 | stringFixed Value | Element IdParameters.parameter:latestQueryOperator.name Parameter name DefinitionThe name of the parameter for the query operator. Note that FHIR strings SHALL NOT exceed 1MB in size
QueryOperator
|
value[x] | S Σ I | 1..1 | Fixed Value | Element IdParameters.parameter:latestQueryOperator.value[x] The value of the query operator parameter (lastn) DefinitionThe value of the query operator parameter (lastn).
lastn
|
valueString | string | Data Type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element IdParameters.parameter:latestQueryOperator.resource If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
|
part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element IdParameters.parameter:latestQueryOperator.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |