Open mHealth to FHIR - Local Development build (v0.0.0). See the Directory of published versions
StructureDefinition-contained-p
source file: source/pages/_includes/contained-p-intro.md
The Open mHealth Contained Patient Profile defines the minimum expectations for the using a contained Patient resource within the Open mHealth DocumentReference profile to represent an opaque patient identifier.
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/contained-p
Published on Fri Nov 23 00:00:00 PST 2018 as active by the Open mHealth.
This profile builds on Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | OMH Contained Patient Profile | |
id | S | 1..1 | string | Contained patient resource id |
identifier | S | 1..1 | Identifier | R24 Server/Shimmer Opaque identifier |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | I | 0..* | Patient | OMH Contained Patient Profile |
id | SΣ | 1..1 | string | Contained patient resource id |
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 | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 1..1 | Identifier | R24 Server/Shimmer Opaque identifier |
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 |
use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | SΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣI | 1..1 | string | The value that is unique Example General: 123456 |
period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use |
name | ΣI | 0..* | HumanName | A name associated with the patient |
telecom | ΣI | 0..* | ContactPoint | A contact detail for the individual |
gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | ΣI | 0..1 | date | The date of birth for the individual |
deceased[x] | ?!ΣI | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | ΣI | 0..* | Address | An address for the individual |
maritalStatus | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) |
multipleBirth[x] | I | 0..1 | Whether patient is part of a multiple birth | |
multipleBirthBoolean | boolean | |||
multipleBirthInteger | integer | |||
photo | I | 0..* | Attachment | Image of the patient |
contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
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 |
relationship | I | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible) |
name | I | 0..1 | HumanName | A name associated with the contact person |
telecom | I | 0..* | ContactPoint | A contact detail for the person |
address | I | 0..1 | Address | Address for the contact person |
gender | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
period | I | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient |
communication | I | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
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 |
language | I | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
preferred | I | 0..1 | boolean | Language preference indicator |
generalPractitioner | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
managingOrganization | ΣI | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
link | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
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 |
other | ΣI | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
type | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required) |
Documentation for this format |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | OMH Contained Patient Profile | |
id | S | 1..1 | string | Contained patient resource id |
identifier | S | 1..1 | Identifier | R24 Server/Shimmer Opaque identifier |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | I | 0..* | Patient | OMH Contained Patient Profile |
id | SΣ | 1..1 | string | Contained patient resource id |
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 | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 1..1 | Identifier | R24 Server/Shimmer Opaque identifier |
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 |
use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | SΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣI | 1..1 | string | The value that is unique Example General: 123456 |
period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use |
name | ΣI | 0..* | HumanName | A name associated with the patient |
telecom | ΣI | 0..* | ContactPoint | A contact detail for the individual |
gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | ΣI | 0..1 | date | The date of birth for the individual |
deceased[x] | ?!ΣI | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | ΣI | 0..* | Address | An address for the individual |
maritalStatus | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) |
multipleBirth[x] | I | 0..1 | Whether patient is part of a multiple birth | |
multipleBirthBoolean | boolean | |||
multipleBirthInteger | integer | |||
photo | I | 0..* | Attachment | Image of the patient |
contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
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 |
relationship | I | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible) |
name | I | 0..1 | HumanName | A name associated with the contact person |
telecom | I | 0..* | ContactPoint | A contact detail for the person |
address | I | 0..1 | Address | Address for the contact person |
gender | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
period | I | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient |
communication | I | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
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 |
language | I | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
preferred | I | 0..1 | boolean | Language preference indicator |
generalPractitioner | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
managingOrganization | ΣI | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
link | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
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 |
other | ΣI | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
type | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required) |
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.