{
"description": null,
"_filename": "StructureDefinition-ReferralRequestTransaction.json",
"package_name": "hl7.fhir.us.bser",
"date": "2019-03-27T07:29:43+11:00",
"derivation": "constraint",
"publisher": "Hi3 Solutions",
"fhirVersion": "3.0.1",
"name": "BSeR Referral Request",
"mapping": [ {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "ReferralRequest",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.2.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "ReferralRequest",
"min": 0,
"definition": "Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.",
"short": "A request for referral or transfer of care",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "clinical.careprovision",
"identity": "w5"
} ],
"alias": [ "ReferralRequest TransferOfCare Request" ],
"max": "*",
"id": "ReferralRequest",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest"
}
}, {
"path": "ReferralRequest.id",
"min": 0,
"definition": "MAY contain zero or one [0..1] id (CONF:4383-802).",
"short": "id",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "ReferralRequest.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "ReferralRequest.meta",
"min": 0,
"definition": "MAY contain zero or one [0..1] meta (CONF:4383-801).",
"short": "meta",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "ReferralRequest.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "ReferralRequest.meta.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.meta.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ReferralRequest.meta.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.meta.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ReferralRequest.meta.versionId",
"min": 0,
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"short": "Version specific identifier",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "ReferralRequest.meta.versionId",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.versionId"
},
"isSummary": true
}, {
"path": "ReferralRequest.meta.lastUpdated",
"min": 0,
"definition": "When the resource last changed - e.g. when the version changed.",
"short": "When the resource version last changed",
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "ReferralRequest.meta.lastUpdated",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.lastUpdated"
},
"isSummary": true
}, {
"path": "ReferralRequest.meta.profile",
"min": 1,
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/bser/StructureDefinition/ReferralRequestTransaction\" (CONF:4383-803).",
"short": "profile",
"type": [ {
"code": "uri"
} ],
"patternString": "http://hl7.org/fhir/us/bser/StructureDefinition/ReferralRequestTransaction",
"max": "1",
"id": "ReferralRequest.meta.profile",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.profile"
},
"isSummary": true
}, {
"path": "ReferralRequest.meta.security",
"min": 0,
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"short": "Security Labels applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "ReferralRequest.meta.security",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.security"
},
"isSummary": true
}, {
"path": "ReferralRequest.meta.tag",
"min": 0,
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"short": "Tags applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
} ],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags"
}
},
"max": "*",
"id": "ReferralRequest.meta.tag",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.tag"
},
"isSummary": true
}, {
"path": "ReferralRequest.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "ReferralRequest.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "ReferralRequest.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "ReferralRequest.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "ReferralRequest.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "ReferralRequest.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "ReferralRequest.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "ReferralRequest.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "ReferralRequest.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "ReferralRequest.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "ReferralRequest.identifier",
"min": 1,
"definition": "SHALL contain exactly one [1..1] identifier (CONF:4383-197).",
"isModifier": false,
"short": "identifier",
"mapping": [ {
"map": "RF1-6 / RF1-11",
"identity": "v2"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "ReferralRequest.identifier",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.identifier"
},
"isSummary": true
}, {
"path": "ReferralRequest.identifier.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.identifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ReferralRequest.identifier.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.identifier.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ReferralRequest.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"max": "1",
"id": "ReferralRequest.identifier.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isSummary": true
}, {
"path": "ReferralRequest.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 1,
"definition": "This identifier SHALL contain exactly one [1..1] type, which SHALL be selected from ValueSet Identifier-type http://hl7.org/fhir/ValueSet/identifier-type DYNAMIC (CONF:4383-218).",
"short": "type",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"max": "1",
"id": "ReferralRequest.identifier.type",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"path": "ReferralRequest.identifier.system",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 0,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"short": "The namespace for the identifier value",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "ReferralRequest.identifier.system",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"path": "ReferralRequest.identifier.value",
"min": 1,
"definition": "This identifier SHALL contain exactly one [1..1] value (CONF:4383-219).",
"short": "value",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ReferralRequest.identifier.value",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/extension-rendered-value.html).",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"path": "ReferralRequest.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "ReferralRequest.identifier.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"path": "ReferralRequest.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "ReferralRequest.identifier.assigner",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"path": "ReferralRequest.definition",
"min": 0,
"definition": "A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.",
"short": "Instantiates protocol or definition",
"mapping": [ {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
} ],
"max": "*",
"id": "ReferralRequest.definition",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.definition"
},
"isSummary": true
}, {
"path": "ReferralRequest.basedOn",
"min": 0,
"definition": "Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.",
"isModifier": false,
"short": "Request fulfilled by this request",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
} ],
"alias": [ "fulfills" ],
"max": "*",
"id": "ReferralRequest.basedOn",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.basedOn"
},
"isSummary": true
}, {
"path": "ReferralRequest.replaces",
"requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"min": 0,
"definition": "Completed or terminated request(s) whose function is taken by this new request.",
"short": "Request(s) replaced by this request",
"mapping": [ {
"map": ".outboundRelationship[typeCode=RPLC].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
} ],
"alias": [ "supersedes", "prior", "renewed order" ],
"max": "*",
"id": "ReferralRequest.replaces",
"comment": "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.replaces"
},
"isSummary": true
}, {
"path": "ReferralRequest.groupIdentifier",
"requirements": "Allows multiple orders to be collected as part of a single requisition.",
"min": 0,
"definition": "The business identifier of the logical \"grouping\" request/order that this referral is a part of.",
"isModifier": false,
"short": "Composite request this is part of",
"type": [ {
"code": "Identifier"
} ],
"alias": [ "grouperId", "requisition" ],
"max": "1",
"id": "ReferralRequest.groupIdentifier",
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.groupIdentifier"
},
"isSummary": true
}, {
"path": "ReferralRequest.status",
"requirements": "Workflow status is handled by the Task resource.",
"min": 1,
"definition": "SHALL contain exactly one [1..1] status, which SHALL be selected from ValueSet Request-status http://hl7.org/fhir/ValueSet/request-status DYNAMIC (CONF:4383-198).",
"isModifier": true,
"short": "status",
"mapping": [ {
"map": "RF1-1",
"identity": "v2"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-status"
}
},
"max": "1",
"id": "ReferralRequest.status",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "ReferralRequest.status"
},
"isSummary": true
}, {
"path": "ReferralRequest.status.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.status.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ReferralRequest.status.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.status.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ReferralRequest.status.value",
"min": 1,
"definition": "This status SHALL contain exactly one [1..1] @value (CONF:4383-220).",
"short": "@value",
"type": [ {
"_code": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:token"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:token"
} ]
},
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex",
"valueString": "[^\\s]+([\\s]?[^\\s]+)*"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.status.value",
"base": {
"max": "1",
"min": 0,
"path": "string.value"
}
}, {
"path": "ReferralRequest.intent",
"requirements": "The same resource structure is used when capturing proposals/recommendations, plans and actual requests.",
"min": 1,
"definition": "Distinguishes the \"level\" of authorization/demand implicit in this request.",
"isModifier": true,
"short": "proposal | plan | order",
"mapping": [ {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferralCategory"
} ],
"description": "Codes identifying the stage lifecycle stage of a request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-intent"
}
},
"alias": [ "category" ],
"max": "1",
"id": "ReferralRequest.intent",
"base": {
"max": "1",
"min": 1,
"path": "ReferralRequest.intent"
},
"isSummary": true
}, {
"path": "ReferralRequest.type",
"min": 0,
"definition": "An indication of the type of referral (or where applicable the type of transfer of care) request.",
"isModifier": false,
"short": "Referral/Transition of care request type",
"mapping": [ {
"map": "RF1-10",
"identity": "v2"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferralType"
} ],
"description": "Codes for types of referral; e.g. consult, transfer, temporary transfer.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/referral-type"
}
},
"max": "1",
"id": "ReferralRequest.type",
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.type"
},
"isSummary": true
}, {
"path": "ReferralRequest.priority",
"min": 0,
"definition": "An indication of the urgency of referral (or where applicable the type of transfer of care) request.",
"isModifier": false,
"short": "Urgency of referral / transfer of care request",
"mapping": [ {
"map": "RF1-2",
"identity": "v2"
}, {
"map": "grade",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferralPriority"
} ],
"description": "Codes indicating the relative priority of the referral.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-priority"
}
},
"max": "1",
"id": "ReferralRequest.priority",
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.priority"
},
"isSummary": true
}, {
"path": "ReferralRequest.serviceRequested",
"min": 1,
"definition": "SHALL contain exactly one [1..1] serviceRequested, which SHALL be selected from ValueSet FHIR c80-practice-codes http://hl7.org/fhir/ValueSet/c80-practice-codes DYNAMIC (CONF:4383-200).",
"isModifier": false,
"short": "serviceRequested",
"mapping": [ {
"map": "PR1-3 / OBR-4",
"identity": "v2"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes"
}
},
"max": "1",
"id": "ReferralRequest.serviceRequested",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.serviceRequested"
},
"isSummary": true
}, {
"path": "ReferralRequest.serviceRequested.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.serviceRequested.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ReferralRequest.serviceRequested.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.serviceRequested.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ReferralRequest.serviceRequested.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"definition": "This serviceRequested SHALL contain exactly one [1..1] coding (CONF:4383-216).",
"short": "coding",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "ReferralRequest.serviceRequested.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "ReferralRequest.serviceRequested.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.serviceRequested.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ReferralRequest.serviceRequested.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.serviceRequested.coding.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ReferralRequest.serviceRequested.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "ReferralRequest.serviceRequested.coding.system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "ReferralRequest.serviceRequested.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ReferralRequest.serviceRequested.coding.version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "ReferralRequest.serviceRequested.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "This coding SHALL contain exactly one [1..1] code (CONF:4383-221).",
"short": "code",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "ReferralRequest.serviceRequested.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "ReferralRequest.serviceRequested.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "This coding SHOULD contain zero or one [0..1] display (CONF:4383-222).",
"short": "display",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ReferralRequest.serviceRequested.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "ReferralRequest.serviceRequested.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "ReferralRequest.serviceRequested.coding.userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "ReferralRequest.serviceRequested.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "This serviceRequested MAY contain zero or one [0..1] text (CONF:4383-223).",
"short": "text",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ReferralRequest.serviceRequested.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "ReferralRequest.subject",
"min": 1,
"definition": "SHALL contain exactly one [1..1] =\"BSeR Patient\"BSeR Patient (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole) (CONF:4383-193).",
"isModifier": false,
"short": "subject",
"mapping": [ {
"map": "PID-3",
"identity": "v2"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole"
} ],
"patternString": "BSeR Patient",
"max": "1",
"id": "ReferralRequest.subject",
"comment": "Referral of family, group or community is to be catered for by profiles.",
"base": {
"max": "1",
"min": 1,
"path": "ReferralRequest.subject"
},
"isSummary": true
}, {
"path": "ReferralRequest.context",
"min": 0,
"definition": "The encounter at which the request for referral or transfer of care is initiated.",
"isModifier": false,
"short": "Originating encounter",
"mapping": [ {
"map": "PV1-19",
"identity": "v2"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
} ],
"alias": [ "encounter" ],
"max": "1",
"id": "ReferralRequest.context",
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.context"
},
"isSummary": true
}, {
"path": "ReferralRequest.occurrence[x]",
"requirements": "Use cases: (1) to indicate that the requested service is not to happen before a specified date, and saving the start date in Period.start; (2) to indicate that the requested service must happen before a specified date, and saving the end date in Period.end; (3) to indicate that the requested service must happen during the specified dates (\"start\" and \"end\" values).",
"min": 0,
"definition": "The period of time within which the services identified in the referral/transfer of care is specified or required to occur.",
"isModifier": false,
"short": "When the service(s) requested in the referral should occur",
"mapping": [ {
"map": "OBR-7/OBR-8",
"identity": "v2"
}, {
"map": "when.planned",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"alias": [ "timing" ],
"max": "1",
"id": "ReferralRequest.occurrence[x]",
"comment": "When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date.",
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.occurrence[x]"
},
"isSummary": true
}, {
"path": "ReferralRequest.authoredOn",
"min": 1,
"definition": "SHALL contain exactly one [1..1] authoredOn (CONF:4383-201).",
"isModifier": false,
"short": "authoredOn",
"mapping": [ {
"map": "RF1-7 / RF1-9?",
"identity": "v2"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "createdOn" ],
"max": "1",
"id": "ReferralRequest.authoredOn",
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.authoredOn"
},
"isSummary": true
}, {
"path": "ReferralRequest.authoredOn.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.authoredOn.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ReferralRequest.authoredOn.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.authoredOn.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ReferralRequest.authoredOn.value",
"min": 1,
"definition": "This authoredOn SHALL contain exactly one [1..1] @value (CONF:4383-224).",
"short": "@value",
"type": [ {
"_code": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:gYear OR xsd:gYearMonth OR xsd:date OR xsd:dateTime"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:gYear OR xsd:gYearMonth OR xsd:date OR xsd:dateTime"
} ]
},
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex",
"valueString": "-?[0-9]{4}(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.authoredOn.value",
"base": {
"max": "1",
"min": 0,
"path": "dateTime.value"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "rfr-1",
"human": "onBehalfOf can only be specified if agent is practitioner or device",
"xpath": "contains(f:agent/f:reference/@value, '/Practitioner/') or contains(f:agent/f:reference/@value, '/Device/') or not(exists(f:onBehalfOf))",
"source": "ReferralRequest.requester",
"severity": "error",
"expression": "(agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()"
} ],
"path": "ReferralRequest.requester",
"min": 1,
"definition": "SHALL contain exactly one [1..1] requester (CONF:4383-194).",
"short": "requester",
"mapping": [ {
"map": ".participation[typeCode=AUT].role",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"alias": [ "author" ],
"max": "1",
"id": "ReferralRequest.requester",
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.requester"
},
"isSummary": true
}, {
"path": "ReferralRequest.requester.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.requester.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ReferralRequest.requester.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.requester.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ReferralRequest.requester.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ReferralRequest.requester.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "ReferralRequest.requester.agent",
"min": 1,
"definition": "This requester SHALL contain exactly one [1..1] =\"BSeR Referral Initiator\"BSeR Practitioner (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson) (CONF:4383-195).",
"short": "agent",
"mapping": [ {
"map": ".player",
"identity": "rim"
}, {
"map": "who.author",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson"
} ],
"patternString": "BSeR Referral Initiator",
"max": "1",
"id": "ReferralRequest.requester.agent",
"base": {
"max": "1",
"min": 1,
"path": "ReferralRequest.requester.agent"
},
"isSummary": true
}, {
"path": "ReferralRequest.requester.onBehalfOf",
"requirements": "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.",
"min": 0,
"definition": "The organization the device or practitioner was acting on behalf of.",
"short": "Organization agent is acting for",
"mapping": [ {
"map": ".scoper",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "ReferralRequest.requester.onBehalfOf",
"condition": [ "rfr-1" ],
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.requester.onBehalfOf"
},
"isSummary": true
}, {
"path": "ReferralRequest.specialty",
"min": 0,
"definition": "Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.",
"isModifier": false,
"short": "The clinical specialty (discipline) that the referral is requested for",
"mapping": [ {
"map": "RF1-3",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferralSpecialty"
} ],
"description": "Codes indicating the types of capability the referred to service provider must have.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/practitioner-specialty"
}
},
"max": "1",
"id": "ReferralRequest.specialty",
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.specialty"
}
}, {
"path": "ReferralRequest.recipient",
"min": 1,
"definition": "SHALL contain exactly one [1..1] =\"BSeR Referral Recipient\"BSeR Practitioner (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson) (CONF:4383-196).",
"isModifier": false,
"short": "recipient",
"mapping": [ {
"map": "Practitioner: PRD-2/PRD-7 where PRD-3 = RT; Organization: PRD-10 where PRD-3 = RT",
"identity": "v2"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson"
} ],
"patternString": "BSeR Referral Recipient",
"max": "1",
"id": "ReferralRequest.recipient",
"comment": "There will be a primary receiver. But the request can be received by any number of \"copied to\" providers or organizations.",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.recipient"
},
"isSummary": true
}, {
"path": "ReferralRequest.reasonCode",
"min": 1,
"definition": "SHALL contain exactly one [1..1] reasonCode, which SHALL be selected from ValueSet Clinical-findings http://hl7.org/fhir/ValueSet/clinical-findings DYNAMIC (CONF:4383-202).",
"isModifier": false,
"short": "reasonCode",
"mapping": [ {
"map": "RF1-10",
"identity": "v2"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"max": "1",
"id": "ReferralRequest.reasonCode",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.reasonCode"
},
"isSummary": true
}, {
"path": "ReferralRequest.reasonCode.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.reasonCode.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ReferralRequest.reasonCode.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.reasonCode.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ReferralRequest.reasonCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"definition": "This reasonCode SHALL contain exactly one [1..1] coding (CONF:4383-217).",
"short": "coding",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "ReferralRequest.reasonCode.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "ReferralRequest.reasonCode.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ReferralRequest.reasonCode.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "ReferralRequest.reasonCode.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ReferralRequest.reasonCode.coding.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "ReferralRequest.reasonCode.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "This coding SHOULD contain zero or one [0..1] system (CONF:4383-225).",
"short": "system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "ReferralRequest.reasonCode.coding.system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "ReferralRequest.reasonCode.coding.version",
"min": 0,
"definition": "This coding MAY contain zero or one [0..1] version (CONF:4383-226).",
"short": "version",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ReferralRequest.reasonCode.coding.version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "ReferralRequest.reasonCode.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "This coding SHALL contain exactly one [1..1] code (CONF:4383-227).",
"short": "code",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "ReferralRequest.reasonCode.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "ReferralRequest.reasonCode.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "This coding SHOULD contain zero or one [0..1] display (CONF:4383-228).",
"short": "display",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ReferralRequest.reasonCode.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "ReferralRequest.reasonCode.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "ReferralRequest.reasonCode.coding.userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "ReferralRequest.reasonCode.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "This reasonCode MAY contain zero or one [0..1] text (CONF:4383-229).",
"short": "text",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ReferralRequest.reasonCode.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "ReferralRequest.reasonReference",
"min": 0,
"definition": "Indicates another resource whose existence justifies this request.",
"short": "Why is service needed?",
"mapping": [ {
"map": ".outboundRelationship[typeCode=RSON].target",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
} ],
"max": "*",
"id": "ReferralRequest.reasonReference",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.reasonReference"
},
"isSummary": true
}, {
"path": "ReferralRequest.description",
"min": 0,
"definition": "The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.",
"isModifier": false,
"short": "A textual description of the referral",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ReferralRequest.description",
"base": {
"max": "1",
"min": 0,
"path": "ReferralRequest.description"
}
}, {
"path": "ReferralRequest.supportingInfo",
"min": 1,
"definition": "SHALL contain exactly one [1..1] supportingInfo=\"BSeR Referral Request Supporting Bundle\" (CONF:4383-203).",
"isModifier": false,
"short": "supportingInfo",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"patternString": "BSeR Referral Request Supporting Bundle",
"max": "1",
"id": "ReferralRequest.supportingInfo",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.supportingInfo"
}
}, {
"id": "ReferralRequest.note",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.note"
},
"path": "ReferralRequest.note",
"type": [ {
"code": "Annotation"
} ],
"short": "Comments made about referral request",
"definition": "Comments made about the referral request by any of the participants."
}, {
"path": "ReferralRequest.relevantHistory",
"min": 0,
"definition": "Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.",
"short": "Key events in history of request",
"mapping": [ {
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance"
} ],
"alias": [ "eventHistory" ],
"max": "*",
"id": "ReferralRequest.relevantHistory",
"comment": "This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.",
"base": {
"max": "*",
"min": 0,
"path": "ReferralRequest.relevantHistory"
}
} ]
},
"status": "draft",
"id": "46a2c3d5-a849-49e5-81d2-88923ae31f4c",
"kind": "resource",
"url": "http://hl7.org/fhir/us/bser/StructureDefinition/ReferralRequestTransaction",
"context": [ "ReferralRequest" ],
"version": "0.2.0",
"differential": {
"element": [ {
"id": "ReferralRequest",
"path": "ReferralRequest"
}, {
"id": "ReferralRequest.id",
"max": "1",
"min": 0,
"path": "ReferralRequest.id",
"short": "id",
"definition": "MAY contain zero or one [0..1] id (CONF:4383-802)."
}, {
"id": "ReferralRequest.meta",
"max": "1",
"min": 0,
"path": "ReferralRequest.meta",
"short": "meta",
"definition": "MAY contain zero or one [0..1] meta (CONF:4383-801)."
}, {
"id": "ReferralRequest.meta.profile",
"max": "1",
"min": 1,
"path": "ReferralRequest.meta.profile",
"short": "profile",
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/bser/StructureDefinition/ReferralRequestTransaction\" (CONF:4383-803).",
"patternString": "http://hl7.org/fhir/us/bser/StructureDefinition/ReferralRequestTransaction"
}, {
"id": "ReferralRequest.identifier",
"max": "1",
"min": 1,
"path": "ReferralRequest.identifier",
"short": "identifier",
"definition": "SHALL contain exactly one [1..1] identifier (CONF:4383-197)."
}, {
"id": "ReferralRequest.identifier.type",
"max": "1",
"min": 1,
"path": "ReferralRequest.identifier.type",
"short": "type",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"definition": "This identifier SHALL contain exactly one [1..1] type, which SHALL be selected from ValueSet Identifier-type http://hl7.org/fhir/ValueSet/identifier-type DYNAMIC (CONF:4383-218)."
}, {
"id": "ReferralRequest.identifier.value",
"max": "1",
"min": 1,
"path": "ReferralRequest.identifier.value",
"short": "value",
"definition": "This identifier SHALL contain exactly one [1..1] value (CONF:4383-219)."
}, {
"id": "ReferralRequest.status",
"max": "1",
"min": 1,
"path": "ReferralRequest.status",
"type": [ {
"code": "code"
} ],
"short": "status",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-status"
}
},
"definition": "SHALL contain exactly one [1..1] status, which SHALL be selected from ValueSet Request-status http://hl7.org/fhir/ValueSet/request-status DYNAMIC (CONF:4383-198)."
}, {
"id": "ReferralRequest.status.value",
"max": "1",
"min": 1,
"path": "ReferralRequest.status.value",
"short": "@value",
"definition": "This status SHALL contain exactly one [1..1] @value (CONF:4383-220)."
}, {
"id": "ReferralRequest.serviceRequested",
"max": "1",
"min": 1,
"path": "ReferralRequest.serviceRequested",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "serviceRequested",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes"
}
},
"definition": "SHALL contain exactly one [1..1] serviceRequested, which SHALL be selected from ValueSet FHIR c80-practice-codes http://hl7.org/fhir/ValueSet/c80-practice-codes DYNAMIC (CONF:4383-200)."
}, {
"id": "ReferralRequest.serviceRequested.coding",
"max": "1",
"min": 1,
"path": "ReferralRequest.serviceRequested.coding",
"short": "coding",
"definition": "This serviceRequested SHALL contain exactly one [1..1] coding (CONF:4383-216)."
}, {
"id": "ReferralRequest.serviceRequested.coding.code",
"max": "1",
"min": 1,
"path": "ReferralRequest.serviceRequested.coding.code",
"short": "code",
"definition": "This coding SHALL contain exactly one [1..1] code (CONF:4383-221)."
}, {
"id": "ReferralRequest.serviceRequested.coding.display",
"max": "1",
"min": 0,
"path": "ReferralRequest.serviceRequested.coding.display",
"short": "display",
"definition": "This coding SHOULD contain zero or one [0..1] display (CONF:4383-222)."
}, {
"id": "ReferralRequest.serviceRequested.text",
"max": "1",
"min": 0,
"path": "ReferralRequest.serviceRequested.text",
"short": "text",
"definition": "This serviceRequested MAY contain zero or one [0..1] text (CONF:4383-223)."
}, {
"id": "ReferralRequest.subject",
"max": "1",
"min": 1,
"path": "ReferralRequest.subject",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole"
} ],
"short": "subject",
"definition": "SHALL contain exactly one [1..1] =\"BSeR Patient\"BSeR Patient (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole) (CONF:4383-193).",
"patternString": "BSeR Patient"
}, {
"id": "ReferralRequest.authoredOn",
"max": "1",
"min": 1,
"path": "ReferralRequest.authoredOn",
"short": "authoredOn",
"definition": "SHALL contain exactly one [1..1] authoredOn (CONF:4383-201)."
}, {
"id": "ReferralRequest.authoredOn.value",
"max": "1",
"min": 1,
"path": "ReferralRequest.authoredOn.value",
"short": "@value",
"definition": "This authoredOn SHALL contain exactly one [1..1] @value (CONF:4383-224)."
}, {
"id": "ReferralRequest.requester",
"max": "1",
"min": 1,
"path": "ReferralRequest.requester",
"short": "requester",
"definition": "SHALL contain exactly one [1..1] requester (CONF:4383-194)."
}, {
"id": "ReferralRequest.requester.agent",
"max": "1",
"min": 1,
"path": "ReferralRequest.requester.agent",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson"
} ],
"short": "agent",
"definition": "This requester SHALL contain exactly one [1..1] =\"BSeR Referral Initiator\"BSeR Practitioner (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson) (CONF:4383-195).",
"patternString": "BSeR Referral Initiator"
}, {
"id": "ReferralRequest.recipient",
"max": "1",
"min": 1,
"path": "ReferralRequest.recipient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson"
} ],
"short": "recipient",
"definition": "SHALL contain exactly one [1..1] =\"BSeR Referral Recipient\"BSeR Practitioner (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson) (CONF:4383-196).",
"patternString": "BSeR Referral Recipient"
}, {
"id": "ReferralRequest.reasonCode",
"max": "1",
"min": 1,
"path": "ReferralRequest.reasonCode",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "reasonCode",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"definition": "SHALL contain exactly one [1..1] reasonCode, which SHALL be selected from ValueSet Clinical-findings http://hl7.org/fhir/ValueSet/clinical-findings DYNAMIC (CONF:4383-202)."
}, {
"id": "ReferralRequest.reasonCode.coding",
"max": "1",
"min": 1,
"path": "ReferralRequest.reasonCode.coding",
"short": "coding",
"definition": "This reasonCode SHALL contain exactly one [1..1] coding (CONF:4383-217)."
}, {
"id": "ReferralRequest.reasonCode.coding.system",
"max": "1",
"min": 0,
"path": "ReferralRequest.reasonCode.coding.system",
"short": "system",
"definition": "This coding SHOULD contain zero or one [0..1] system (CONF:4383-225)."
}, {
"id": "ReferralRequest.reasonCode.coding.version",
"max": "1",
"min": 0,
"path": "ReferralRequest.reasonCode.coding.version",
"short": "version",
"definition": "This coding MAY contain zero or one [0..1] version (CONF:4383-226)."
}, {
"id": "ReferralRequest.reasonCode.coding.code",
"max": "1",
"min": 1,
"path": "ReferralRequest.reasonCode.coding.code",
"short": "code",
"definition": "This coding SHALL contain exactly one [1..1] code (CONF:4383-227)."
}, {
"id": "ReferralRequest.reasonCode.coding.display",
"max": "1",
"min": 0,
"path": "ReferralRequest.reasonCode.coding.display",
"short": "display",
"definition": "This coding SHOULD contain zero or one [0..1] display (CONF:4383-228)."
}, {
"id": "ReferralRequest.reasonCode.text",
"max": "1",
"min": 0,
"path": "ReferralRequest.reasonCode.text",
"short": "text",
"definition": "This reasonCode MAY contain zero or one [0..1] text (CONF:4383-229)."
}, {
"id": "ReferralRequest.supportingInfo",
"max": "1",
"min": 1,
"path": "ReferralRequest.supportingInfo",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"short": "supportingInfo",
"definition": "SHALL contain exactly one [1..1] supportingInfo=\"BSeR Referral Request Supporting Bundle\" (CONF:4383-203).",
"patternString": "BSeR Referral Request Supporting Bundle"
} ]
},
"contact": [ {
"name": "AbdulMalik Shakir",
"telecom": [ {
"use": "work",
"value": "6266444491",
"system": "phone"
}, {
"use": "work",
"value": "abdulmalik.shakir@hi3solutions.com",
"system": "email"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}