Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: CareConnectRelatedPerson1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1 Version: 0.1.0
Draft as of 2019-03-01 Computable Name: CareConnect-RelatedPerson-1

Copyright/Legal: Copyright © 2016 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

[NOT CURATED BY INTEROPEN see: http://www.interopen.org/careconnect-curation-methodology/] Initial development for the Digital Maternity programme

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonAn person that is related to a patient, but who is not a direct target of care
... identifier
.... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... patient 1..1Reference(CareConnectPatient1)The patient this person is related to

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonAn person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this related person's record is in active use

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorRelatedPersonIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonAn person that is related to a patient, but who is not a direct target of care
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient Σ1..1Reference(CareConnectPatient1)The patient this person is related to
... relationship Σ0..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person

... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.identifier.userequiredIdentifierUse
RelatedPerson.identifier.typeextensibleIdentifier Type Codes
RelatedPerson.relationshippreferredPatientRelationshipType
RelatedPerson.genderrequiredAdministrativeGender

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonAn person that is related to a patient, but who is not a direct target of care
... identifier
.... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... patient 1..1Reference(CareConnectPatient1)The patient this person is related to

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonAn person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this related person's record is in active use

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorRelatedPersonIf 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonAn person that is related to a patient, but who is not a direct target of care
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient Σ1..1Reference(CareConnectPatient1)The patient this person is related to
... relationship Σ0..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person

... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.identifier.userequiredIdentifierUse
RelatedPerson.identifier.typeextensibleIdentifier Type Codes
RelatedPerson.relationshippreferredPatientRelationshipType
RelatedPerson.genderrequiredAdministrativeGender

 

Other representations of profile: CSV, Excel, Schematron