Open mHealth to HL7 FHIR® Implementation Guide CI Build

Open mHealth to FHIR - Local Development build (v0.0.0). See the Directory of published versions

StructureDefinition-omh-dr

source file: source/pages/_includes/omh-dr-intro.md

The Open mHealth (OMH) Document Reference Profile defines the minimum expectations for the using the DocumentReference resource to record, search and fetch omh schema in its native json format.

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://www.fhir.org/guides/omhtofhir/StructureDefinition/omh-dr

Published on Wed Jun 05 00:00:00 PDT 2019 as active by the Open mHealth.

This profile builds on DocumentReference

Summary

Mandatory: 8 elements
Must-Support: 15 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceOMH DocumentReference Profile
... contained S1..*OmhContainedPatientProfileContained patient resource.
... identifier S0..*IdentifierOther identifiers for the document
... status S1..1codecurrent | superseded | entered-in-error
... type S1..1CodeableConceptOMH datapoint type
Binding: Open mHealth Datapoint Types (extensible)
.... text S1..1stringOmh Schema name
... category S1..1CodeableConceptOMH datapoint category
Fixed Value: As shown
.... text1..1stringPlain text representation of the concept
Fixed Value: OMH datapoint
... subject SI1..1Reference(Patient)Who/what is the subject of the document
omh-1: SHALL be a reference to a contained patient.
.... reference SI1..1stringReference to contained patient
... date S0..1instantWhen this document reference was created
... content S1..*BackboneElementOmh datapoint url
.... attachment S1..1AttachmentWhere to access the document
..... contentType S1..1codeMime type of the content, with charset etc.
Fixed Value: application/json
..... url S1..1urlUri where the data can be found
... context S0..1BackboneElementClinical context of document
.... period S0..1PeriodOmh schema date range

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference I0..*DocumentReferenceOMH DocumentReference Profile
... 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 SI1..*OmhContainedPatientProfileContained patient resource.
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... masterIdentifier ΣI0..1IdentifierMaster Version Specific Identifier
... identifier SΣI0..*IdentifierOther identifiers for the document
... status ?!SΣI1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
... docStatus ΣI0..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type SΣI1..1CodeableConceptOMH datapoint type
Binding: Open mHealth Datapoint Types (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text SΣI1..1stringOmh Schema name
... category SΣI1..1CodeableConceptOMH datapoint category
Binding: DocumentClassValueSet (example)

Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding0..0CodingCode defined by a terminology system
.... text1..1stringPlain text representation of the concept
Fixed Value: OMH datapoint
... subject SΣI1..1Reference(Patient)Who/what is the subject of the document
omh-1: SHALL be a reference to a contained patient.
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringReference to contained patient
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... date SΣI0..1instantWhen this document reference was created
... author ΣI0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the document
... authenticator I0..1Reference(Practitioner | PractitionerRole | Organization)Who/what authenticated the document
... custodian I0..1Reference(Organization)Organization which maintains the document
... relatesTo ΣI0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target ΣI1..1Reference(DocumentReference)Target of the relationship
... description ΣI0..1stringHuman-readable description
... securityLabel ΣI0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible)
... content SΣI1..*BackboneElementOmh datapoint url
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment SΣI1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣI1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
Fixed Value: application/json
..... language ΣI0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
Example General: en-AU
..... data I0..1base64BinaryData inline, base64ed
..... url SΣI1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size ΣI0..1unsignedIntNumber of bytes of content (if url provided)
..... hash ΣI0..1base64BinaryHash of the data (sha-1, base64ed)
..... title ΣI0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation ΣI0..1dateTimeDate attachment was first created
.... format ΣI0..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred)
... context SΣI0..1BackboneElementClinical context of document
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... encounter I0..*Reference(Encounter | EpisodeOfCare)Context of the document content
.... event I0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example)
.... period SΣI0..1PeriodOmh schema date range
.... facilityType I0..1CodeableConceptKind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example)
.... practiceSetting I0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example)
.... sourcePatientInfo I0..1Reference(Patient)Patient demographics from source
.... related I0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

Summary

Mandatory: 8 elements
Must-Support: 15 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceOMH DocumentReference Profile
... contained S1..*OmhContainedPatientProfileContained patient resource.
... identifier S0..*IdentifierOther identifiers for the document
... status S1..1codecurrent | superseded | entered-in-error
... type S1..1CodeableConceptOMH datapoint type
Binding: Open mHealth Datapoint Types (extensible)
.... text S1..1stringOmh Schema name
... category S1..1CodeableConceptOMH datapoint category
Fixed Value: As shown
.... text1..1stringPlain text representation of the concept
Fixed Value: OMH datapoint
... subject SI1..1Reference(Patient)Who/what is the subject of the document
omh-1: SHALL be a reference to a contained patient.
.... reference SI1..1stringReference to contained patient
... date S0..1instantWhen this document reference was created
... content S1..*BackboneElementOmh datapoint url
.... attachment S1..1AttachmentWhere to access the document
..... contentType S1..1codeMime type of the content, with charset etc.
Fixed Value: application/json
..... url S1..1urlUri where the data can be found
... context S0..1BackboneElementClinical context of document
.... period S0..1PeriodOmh schema date range

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference I0..*DocumentReferenceOMH DocumentReference Profile
... 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 SI1..*OmhContainedPatientProfileContained patient resource.
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... masterIdentifier ΣI0..1IdentifierMaster Version Specific Identifier
... identifier SΣI0..*IdentifierOther identifiers for the document
... status ?!SΣI1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
... docStatus ΣI0..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required)
... type SΣI1..1CodeableConceptOMH datapoint type
Binding: Open mHealth Datapoint Types (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text SΣI1..1stringOmh Schema name
... category SΣI1..1CodeableConceptOMH datapoint category
Binding: DocumentClassValueSet (example)

Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding0..0CodingCode defined by a terminology system
.... text1..1stringPlain text representation of the concept
Fixed Value: OMH datapoint
... subject SΣI1..1Reference(Patient)Who/what is the subject of the document
omh-1: SHALL be a reference to a contained patient.
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringReference to contained patient
.... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
.... display ΣI0..1stringText alternative for the resource
... date SΣI0..1instantWhen this document reference was created
... author ΣI0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the document
... authenticator I0..1Reference(Practitioner | PractitionerRole | Organization)Who/what authenticated the document
... custodian I0..1Reference(Organization)Organization which maintains the document
... relatesTo ΣI0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target ΣI1..1Reference(DocumentReference)Target of the relationship
... description ΣI0..1stringHuman-readable description
... securityLabel ΣI0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible)
... content SΣI1..*BackboneElementOmh datapoint url
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment SΣI1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣI1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
Fixed Value: application/json
..... language ΣI0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
Example General: en-AU
..... data I0..1base64BinaryData inline, base64ed
..... url SΣI1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size ΣI0..1unsignedIntNumber of bytes of content (if url provided)
..... hash ΣI0..1base64BinaryHash of the data (sha-1, base64ed)
..... title ΣI0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation ΣI0..1dateTimeDate attachment was first created
.... format ΣI0..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred)
... context SΣI0..1BackboneElementClinical context of document
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... encounter I0..*Reference(Encounter | EpisodeOfCare)Context of the document content
.... event I0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example)
.... period SΣI0..1PeriodOmh schema date range
.... facilityType I0..1CodeableConceptKind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example)
.... practiceSetting I0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example)
.... sourcePatientInfo I0..1Reference(Patient)Patient demographics from source
.... related I0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

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


Quick Start

Below is an overview of the required set of Server RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.