HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1.0 (Standard for Trial Use)

This page is part of the Occupational Data for Health (ODH) FHIR IG (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

ActionRequest

 

The official URL for this profile is:

http://hl7.org/fhir/us/odh/StructureDefinition/obf-ActionRequest

Abstract class representing a request for any type of action to be performed.

This profile builds on DomainResource.

This profile was published on Sat Jan 04 00:00:00 UTC 2020 as a active by HL7 International Public Health Work Group.

Summary

Mandatory: 0 element (3 nested mandatory elements)

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.ActionRequest maps to DomainResource:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.source
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource DomainResourceAction Request
... extension 3..*
... obf-Status-extension I1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension I0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Identifier-extension
... obf-SubjectOfRecord-extension I1..1Reference(US Core Patient Profile | Practitioner | Group | Device | Specimen | Location | Medication | ResearchSubject)SubjectOfRecord
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension
... obf-CareContext-extension I0..1Reference(Encounter | EpisodeOfCare)CareContext
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-CareContext-extension
... obf-StatementDateTime-extension I0..1dateTimeStatementDateTime
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-StatementDateTime-extension
... obf-ReasonCode-extension I0..*CodeableConceptReasonCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ReasonCode-extension
... obf-ReasonReference-extension I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure)ReasonReference
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ReasonReference-extension
... obf-BasedOn-extension I0..*Reference(ServiceRequest | MedicationRequest | CarePlan)BasedOn
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-BasedOn-extension
... obf-datatype-Code-extension I0..1CodeableConceptCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Code-extension
... obf-datatype-Category-extension I0..*CodeableConceptCategory
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Category-extension
... obf-Requester-extension I0..1Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson | Device | Practitioner Role)Requester
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Requester-extension
... obf-RequestIntent-extension I1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-RequestIntent-extension
... obf-ExpectedPerformanceTime-extension I0..1dateTime, Period, TimingExpectedPerformanceTime
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformanceTime-extension
... obf-ExpectedPerformerType-extension I0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformerType-extension
... obf-ExpectedPerformer-extension I0..*Reference(US Core Patient Profile | Practitioner | RelatedPerson | Organization | Device)ExpectedPerformer
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformer-extension
... obf-datatype-PriorityCode-extension I0..1positiveInt, CodeableConceptPriorityCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-PriorityCode-extension
... obf-Annotation-extension I0..*AnnotationAnnotation
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Annotation-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource I0..*DomainResourceAction Request
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I3..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... obf-Status-extension I1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension I0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Identifier-extension
... obf-SubjectOfRecord-extension I1..1Reference(US Core Patient Profile | Practitioner | Group | Device | Specimen | Location | Medication | ResearchSubject)SubjectOfRecord
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension
... obf-CareContext-extension I0..1Reference(Encounter | EpisodeOfCare)CareContext
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-CareContext-extension
... obf-StatementDateTime-extension I0..1dateTimeStatementDateTime
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-StatementDateTime-extension
... obf-ReasonCode-extension I0..*CodeableConceptReasonCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ReasonCode-extension
... obf-ReasonReference-extension I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure)ReasonReference
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ReasonReference-extension
... obf-BasedOn-extension I0..*Reference(ServiceRequest | MedicationRequest | CarePlan)BasedOn
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-BasedOn-extension
... obf-datatype-Code-extension I0..1CodeableConceptCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Code-extension
... obf-datatype-Category-extension I0..*CodeableConceptCategory
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Category-extension
... obf-Requester-extension I0..1Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson | Device | Practitioner Role)Requester
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Requester-extension
... obf-RequestIntent-extension I1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-RequestIntent-extension
... obf-ExpectedPerformanceTime-extension I0..1dateTime, Period, TimingExpectedPerformanceTime
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformanceTime-extension
... obf-ExpectedPerformerType-extension I0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformerType-extension
... obf-ExpectedPerformer-extension I0..*Reference(US Core Patient Profile | Practitioner | RelatedPerson | Organization | Device)ExpectedPerformer
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformer-extension
... obf-datatype-PriorityCode-extension I0..1positiveInt, CodeableConceptPriorityCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-PriorityCode-extension
... obf-Annotation-extension I0..*AnnotationAnnotation
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Annotation-extension
... modifierExtension ?!I0..*(Slice Definition)Extensions that cannot be ignored
Slice: Unordered, Open by value:url

doco Documentation for this format

Summary

Mandatory: 0 element (3 nested mandatory elements)

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.ActionRequest maps to DomainResource:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.source
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource DomainResourceAction Request
... extension 3..*
... obf-Status-extension I1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension I0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Identifier-extension
... obf-SubjectOfRecord-extension I1..1Reference(US Core Patient Profile | Practitioner | Group | Device | Specimen | Location | Medication | ResearchSubject)SubjectOfRecord
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension
... obf-CareContext-extension I0..1Reference(Encounter | EpisodeOfCare)CareContext
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-CareContext-extension
... obf-StatementDateTime-extension I0..1dateTimeStatementDateTime
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-StatementDateTime-extension
... obf-ReasonCode-extension I0..*CodeableConceptReasonCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ReasonCode-extension
... obf-ReasonReference-extension I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure)ReasonReference
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ReasonReference-extension
... obf-BasedOn-extension I0..*Reference(ServiceRequest | MedicationRequest | CarePlan)BasedOn
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-BasedOn-extension
... obf-datatype-Code-extension I0..1CodeableConceptCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Code-extension
... obf-datatype-Category-extension I0..*CodeableConceptCategory
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Category-extension
... obf-Requester-extension I0..1Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson | Device | Practitioner Role)Requester
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Requester-extension
... obf-RequestIntent-extension I1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-RequestIntent-extension
... obf-ExpectedPerformanceTime-extension I0..1dateTime, Period, TimingExpectedPerformanceTime
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformanceTime-extension
... obf-ExpectedPerformerType-extension I0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformerType-extension
... obf-ExpectedPerformer-extension I0..*Reference(US Core Patient Profile | Practitioner | RelatedPerson | Organization | Device)ExpectedPerformer
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformer-extension
... obf-datatype-PriorityCode-extension I0..1positiveInt, CodeableConceptPriorityCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-PriorityCode-extension
... obf-Annotation-extension I0..*AnnotationAnnotation
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Annotation-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DomainResource I0..*DomainResourceAction Request
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I3..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... obf-Status-extension I1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Status-extension
... obf-datatype-Identifier-extension I0..*IdentifierIdentifier
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Identifier-extension
... obf-SubjectOfRecord-extension I1..1Reference(US Core Patient Profile | Practitioner | Group | Device | Specimen | Location | Medication | ResearchSubject)SubjectOfRecord
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-SubjectOfRecord-extension
... obf-CareContext-extension I0..1Reference(Encounter | EpisodeOfCare)CareContext
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-CareContext-extension
... obf-StatementDateTime-extension I0..1dateTimeStatementDateTime
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-StatementDateTime-extension
... obf-ReasonCode-extension I0..*CodeableConceptReasonCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ReasonCode-extension
... obf-ReasonReference-extension I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure)ReasonReference
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ReasonReference-extension
... obf-BasedOn-extension I0..*Reference(ServiceRequest | MedicationRequest | CarePlan)BasedOn
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-BasedOn-extension
... obf-datatype-Code-extension I0..1CodeableConceptCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Code-extension
... obf-datatype-Category-extension I0..*CodeableConceptCategory
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-Category-extension
... obf-Requester-extension I0..1Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson | Device | Practitioner Role)Requester
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Requester-extension
... obf-RequestIntent-extension I1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-RequestIntent-extension
... obf-ExpectedPerformanceTime-extension I0..1dateTime, Period, TimingExpectedPerformanceTime
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformanceTime-extension
... obf-ExpectedPerformerType-extension I0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformerType-extension
... obf-ExpectedPerformer-extension I0..*Reference(US Core Patient Profile | Practitioner | RelatedPerson | Organization | Device)ExpectedPerformer
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-ExpectedPerformer-extension
... obf-datatype-PriorityCode-extension I0..1positiveInt, CodeableConceptPriorityCode
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-PriorityCode-extension
... obf-Annotation-extension I0..*AnnotationAnnotation
URL: http://hl7.org/fhir/us/odh/StructureDefinition/obf-Annotation-extension
... modifierExtension ?!I0..*(Slice Definition)Extensions that cannot be ignored
Slice: Unordered, Open by value:url

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
DomainResource.languagepreferredCommonLanguages
Max Binding: AllLanguages

 

Constraints

IdPathDetailsRequirements
dom-2DomainResourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3DomainResourceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4DomainResourceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5DomainResourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6DomainResourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1DomainResource.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DomainResource.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DomainResource.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DomainResource.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DomainResource.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DomainResource.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()