OpenmHealthtoFHIR

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

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	OMH DocumentReference Profile
contained	S	1..*	OmhContainedPatientProfile	Contained patient resource.
identifier	S	0..*	Identifier	Other identifiers for the document
status	S	1..1	code	current \| superseded \| entered-in-error
type	S	1..1	CodeableConcept	OMH datapoint type Binding: Open mHealth Datapoint Types (extensible)
text	S	1..1	string	Omh Schema name
category	S	1..1	CodeableConcept	OMH datapoint category Fixed Value: As shown
text		1..1	string	Plain text representation of the concept Fixed Value: OMH datapoint
subject	SI	1..1	Reference(Patient)	Who/what is the subject of the document omh-1: SHALL be a reference to a contained patient.
reference	SI	1..1	string	Reference to contained patient
date	S	0..1	instant	When this document reference was created
content	S	1..*	BackboneElement	Omh datapoint url
attachment	S	1..1	Attachment	Where to access the document
contentType	S	1..1	code	Mime type of the content, with charset etc. Fixed Value: application/json
url	S	1..1	url	Uri where the data can be found
context	S	0..1	BackboneElement	Clinical context of document
period	S	0..1	Period	Omh schema date range
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	I	0..*	DocumentReference	OMH DocumentReference Profile
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained	SI	1..*	OmhContainedPatientProfile	Contained patient resource.
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	ΣI	0..1	Identifier	Master Version Specific Identifier
identifier	SΣI	0..*	Identifier	Other identifiers for the document
status	?!SΣI	1..1	code	current \| superseded \| entered-in-error Binding: DocumentReferenceStatus (required)
docStatus	ΣI	0..1	code	preliminary \| final \| amended \| entered-in-error Binding: CompositionStatus (required)
type	SΣI	1..1	CodeableConcept	OMH datapoint type Binding: Open mHealth Datapoint Types (extensible)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	ΣI	0..*	Coding	Code defined by a terminology system
text	SΣI	1..1	string	Omh Schema name
category	SΣI	1..1	CodeableConcept	OMH datapoint category Binding: DocumentClassValueSet (example) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		0..0	Coding	Code defined by a terminology system
text		1..1	string	Plain text representation of the concept Fixed Value: OMH datapoint
subject	SΣI	1..1	Reference(Patient)	Who/what is the subject of the document omh-1: SHALL be a reference to a contained patient.
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣI	1..1	string	Reference to contained patient
type	ΣI	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible)
identifier	ΣI	0..1	Identifier	Logical reference, when literal reference is not known
display	ΣI	0..1	string	Text alternative for the resource
date	SΣI	0..1	instant	When this document reference was created
author	ΣI	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| Device \| Patient \| RelatedPerson)	Who and/or what authored the document
authenticator	I	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Who/what authenticated the document
custodian	I	0..1	Reference(Organization)	Organization which maintains the document
relatesTo	ΣI	0..*	BackboneElement	Relationships to other documents
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	ΣI	1..1	code	replaces \| transforms \| signs \| appends Binding: DocumentRelationshipType (required)
target	ΣI	1..1	Reference(DocumentReference)	Target of the relationship
description	ΣI	0..1	string	Human-readable description
securityLabel	ΣI	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible)
content	SΣI	1..*	BackboneElement	Omh datapoint url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣI	1..1	Attachment	Where to access the document
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣI	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required) Fixed Value: application/json
language	ΣI	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred) Max Binding: AllLanguages Example General: en-AU
data	I	0..1	base64Binary	Data inline, base64ed
url	SΣI	1..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	ΣI	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	ΣI	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	ΣI	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	ΣI	0..1	dateTime	Date attachment was first created
format	ΣI	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred)
context	SΣI	0..1	BackboneElement	Clinical context of document
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
encounter	I	0..*	Reference(Encounter \| EpisodeOfCare)	Context of the document content
event	I	0..*	CodeableConcept	Main clinical acts documented Binding: v3 Code System ActCode (example)
period	SΣI	0..1	Period	Omh schema date range
facilityType	I	0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example)
practiceSetting	I	0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example)
sourcePatientInfo	I	0..1	Reference(Patient)	Patient demographics from source
related	I	0..*	Reference(Resource)	Related identifiers or resources
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.